Documentation

This subdirectory contains the reStructuredText documentation that can be built with sphinx.

Building the documentation

To build the documentation, you will need to have installed:

• sphinx
• sphinx-argparse

Then simply type:

make html

and the HTML documentation will be installed in ./_build/html/.

Notes

Note that the configuration automatically created by sphinx-quickstart has been modified in the following ways:

• conf.py has been modified to read the version and package information from ../phydmslib/_metadata.py
• Makefile has been modified to automatically run `sphinx-apidoc`_ when invoked with make html.