Documentation

Everything about writing and building this site. Start here if you are documenting a module you wrote, or if you need the site to build on your machine.

• Documenting code explains how to write docstrings the way this project renders them: the NumPy standard, parsed by numpydoc and nothing else.

• Building the docs explains how to build the site locally, what each Makefile target does, and how to fix the build failures this repository is known to produce.

• Design system explains where the visual design lives and how to extend the site without breaking its consistency.

• FAQ answers which file controls which part of the site, and points at the Sphinx documentation for anything beyond that.

The data access section and the generated pages of rotifer.db are the reference implementation: when in doubt about how a docstring or a section page should look, copy what rotifer.db does.