Documenting DaVinci

This documentation is written in reStructuredText and built in to web pages by Sphinx. The source can be found in the doc directory of the DaVinci project.

We follow the Google style guide (example) when writing docstrings in Python.

Building the documentation locally

After building DaVinci, to get the documentation pages to build and be written to DaVinci/doc/_build/html/, run the following commands:

DaVinci/run make -C DaVinci/doc html
DaVinci/run make -C DaVinci/doc linkcheck