Build documentation with Sphinx¶
Build HTML locally¶
After the package is installed, the documentation can be built by following these steps in the terminal:
Install required dependencies:
cd docs/
conda install pandoc
pip install -r requirements.txt
Build documentation:
make clean html
cd ..
View the documentation:
The built HTML documentation can be found at
docs/build/html/index.html. Opening this file in a web browser will display the API references and other documentation.