Skip to content

Documentation generation

Tristan Israël edited this page Feb 10, 2026 · 5 revisions

Prerequisites:

  • Install the dependencies by running $ python3 -m pip install -r requirements-doc.txt in the folder python/lib/src/safecor.

Procedure:

  • Go to the root of the library: $ cd python/lib
  • Make the documentation: $ poetry run sphinx-build -b html docs/source docs/build/html
  • Clean the documentation: $ rm -rf docs/build docs/source/api/generated

Clone this wiki locally