Documenting Moore

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 Moore project.

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

Building the documentation locally

It is enough to run the following command to get the documentation in Moore/doc/_build/html

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