Build Documentation
Last updated
Last updated
This manual can be built locally using . To do so, a python environment must be created.
git
shall be available to clone the repository. Otherwise, you may want to manually download the archive.
python
shall be available to build the documentation.
If doxygen
generated documentation is required, shall be available. It also uses graphviz
to generate the graph, install it according to the .
Please follow the instructions below to create a local editing environment.
Clone the repository using the following command:
Within the suanPan-manual
directory, create a new virtual environment using whatever tools you have available. Here the plain python virtual environment is used.
Now that the virtual environment is created, install the requirements using the following command:
Alternatively, if the doxygen
documentation is required, the following command can be used:
Note doxygen
and git
are required to be available. This also installs a custom mkdocs plugin to overwrite inline math expressions to properly render them.
The following command builds and runs the server on localhost:8000
.
The server monitors changes in real time. Now you can make changes to the manual and check the changes in the browser.