Building the docs¶

The project’s documentation is built using Sphinx and hosted on Read The Docs.

Generating API documentation¶

The documentation in docstrings has to be “converted” to .rst files using autodoc before the documentation can be built:

sphinx-apidoc --force -o docs/source/api hashtablebot

To generate the documentation’s html files, use the following:

sphinx-build -b html docs/source/ docs/build/html

The docs are deployed automatically when the main branch is updated.