Install the the following:
pip install sphinx
pip install sphinx_rtd_theme
pip install nbsphinx
pip install numpydocTo build the docs for the first time, navigate to mygrad/docs/source/
and generate the proper .rst files via:
sphinx-autogen -o generated/ *.rstThen navigate to mygrad/docs/ and run:
make htmlon Windows, the command is:
make.bat htmlThis will create the mygrad/docs/build/ directory, which contains the html for
the documentation. You can delete this directory and rerun the above command to
force a clean build of the html. This is typically needed if a new page has been
introduced, but the quick-navigation index does not change.