Documentation

Documentation is handled via Sphinx. We also utilize the sphinx-rtd-theme so that we can maintain consistency across our documentations look and functionality.

Building the documentation

To build the documentation, you’ll need to have markdownclerk, sphinx and the sphinx-rtd-theme installed (via virtualenv or otherwise). Once you have that done, simply cd into the docs directory and run:

make html

You should see the build output into _build/html, which you can then browse.

Building the API documentation

To build the documentation for the module, run the following command from the top level directory of the repo:

sphinx-apidoc -e -f -o docs/api markdownclerk

This will generate the docs for any code that has docstrings in it. From there you can follow the same instructions for building the documentation above.