Skip to content

Latest commit

 

History

History
 
 

Some helpful hints for using Sphinx:

To build the documentation:

$ source venv/bin/activate
$ make html

The homepage is at _build/html/index.html. You should be able to navigate the entire site from that page.

References:

Some special syntax useful in Sphinx:

:doc:`otherpage`
:ref:`coolsection`

doc allows you to link to another page. The name of the page will be used for the link.

ref allows you to link to any label, like a specific section. See the Sphinx docs for more details.