Documentation¶
Documentation for this project is written in reStructuredText and rendered
with Sphinx. Most documentation exists in the form of docstrings and
sometimes as individual .rst
files.
We adopt the NumPy/SciPy Documentation convention for docstrings, although Google Style Python Docstrings are also acceptable if you’re in a hurry and don’t have time to contribute extensive documentation.
The nice thing about standards is that there are so many of them to choose from.
—Andrew S. Tanenbaum
The builtin Sphinx extension Napoleon is used to parse both NumPy and Google style docstrings.
To build the documentation, simply execute setup.py
with the
build_sphinx
subcommand:
$ python setup.py build_sphinx
You can also run make
from the docs
directory with the html
option.
$ make html
To deploy to Github Pages, simply run:
$ make ghp
which will build the html and automatically commit it to the gh-pages
branch and push it to Github using the ghp-import
tool.