Click on the badge to get to the compiled version of the mathematical documentation.
To write the documentation, use an editor of your choice and add your formulas in the respective rst file in doc/source/frameworks.
Compiling is done by sphinx, therefore you need a python environment. If you use conda, you can install the necessary packages doing the following steps:
- Download the environment file.
- Launch a new command prompt (Windows: Win+R, type "cmd", Enter)
- Install it via conda by
conda env create -f mathdoc.yml. - Each time you open a new terminal for compiling, you can activate the environment by
conda activate mathdoc.
You can build the html pages by simply running while you are in the doc folder (ensure that you have a subfolder in doc named build and a subfolder named _static in doc/source):
sphinx-build -b html source build