Contributing to the Documentation

The source for Pepys Import documentation is in this directory. Our documentation uses Sphinx and Sphinx’s RTD Theme.

Building the documentation

• Install requirements.txt in the top level of the project: pip install -r requirements.txt .

• From the top level directory, cd into the docs/ folder and run: make html

If you would like regenerate the document structure:

• sphinx-quickstart (sphinx-quickstart documentation) can be called to set up a source directory and create necessary configurations.

• Another option is using the following code: sphinx-apidoc -F -o docs pepys_import (sphinx-apidoc documentation)

After it’s done, you can run make html in docs/ folder.