For the automatic documentation to work, please follow the code style
guidelines for
docstrings.
To compile the autodoc with sphinx, simply install sphinx > 1.3
(pip install sphinx
) and type (starting from the pyrpl root
directory)
cd doc/sphinx
make html
An extensive discussion of the (automatic) documentation can be found in issue #291.
A few useful links and older information (from issue #85):
cd doc/sphinx
sphinx-apidoc -f -o source/ ../../pyrpl/
make html
Current version of autodoc: https://github.com/lneuhaus/pyrpl/blob/master/doc/sphinx/build/html/pyrpl.html