The docs for this project are built with Sphinx.
Ensure that Sphinx and the ReadTheDocs theme are installed:
conda install sphinx sphinx_rtd_theme
Create API documentation automatically with sphinx-apidoc
:
sphinx-apidoc -f -M -e -T -o source/api ../gninatorch
Use the Makefile
to compile static HTML pages:
make html
The compiled docs will be in the build
directory and can be viewed by opening index.html
(which may itself be inside a directory called html/
depending on what version of Sphinx is installed).