Documentation
You will also need to install mdbook
. It is used to automatically generate documentation from the md
format to the HTML
format, just like this web page. The installation can be done using :
cargo install mdbook
To launch the development server for the documentation, you can run :
# in the tramex repository
mdbook serve docs/
Crates documentation
Latest crates documentation is deployed and available on the local website:
- tramex at https://tramex.github.io/tramex/crates/tramex/
- tramex-tools at https://tramex.github.io/tramex/crates/tramex_tools