To build the documentation, you will need Sphinx and various dependencies. You can install them via:
cd docs/
pip install -r requirements.txt
You can then build the documentation by running make <format>
from the docs/
folder. Run make
to get a list of all
available output formats. The most common case is html
:
make html
Feel free to open an issue or pull request regarding any inaccuracy or potential improvement for our documentation. Thank you!