Using Sphinx for building documentation¶

Sphinx is a powerful documentation generator that converts reStructuredText files into various output formats, including HTML and PDF.

This guide provides an overview of how to use Sphinx for building the documentation of this project.

Installation¶

To install Sphinx, you can use pip:

python3 -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt

To build the documentation, navigate to the docs directory and run the following command:

make html

This will generate the HTML documentation in the _build/html directory. You can open the index.html file in a web browser to view the documentation.