Building Documentation

The documentation for Trodes is in the doc directory. It can be viewed online at The following instructions are for building and viewing locally on a development machine.


pip install sphinx
pip install sphinx_rtd_theme


This is only supported on Linux or Mac.

cd doc
make html

Now you can view the HTML files generated in doc/_build.


We welcome contributions to our documentation. Documentation is written in ReStructuredText (ReST). Because ReST is flexible in specifying headers, we have standardized on this format.

Header level 1

Header level 2

Header level 3

Header level 4

Header level 5