Generating the docs

Docs are autogenerated using:

• Sphinx and reST

• MyST for Markdown support

• autodoc for automatic docs generation based on docstrings

• napoleon for NumPy-style docstring support

• autodoc_typehints for automatic docs generation based on type hints

To generate the project docs, first, go through Project setup, then run the following command:

sphinx-build -M html docs/source/ docs/build/

This will generate HTML documentation and save it to the docs/build/ folder. From there, open index.html to browse the documentation.

Hot-reload server

Alternatively, you can also run:

sphinx-autobuild docs/source docs/build/html --watch src --watch main.py

This will start a hot-reload server that updates the documentation whenever you edit reST or MyST Sphinx source files or Python source files. The command should output a link to open in your browser, e.g.:

[sphinx-autobuild] Serving on http://127.0.0.1:8000