Installation and docs buildΒΆ
Create and activate a virtual environment (recommended):
python3 -m venv .venv
source .venv/bin/activate
If you already use a named environment (for example ``Env_TG``), activate that instead.
Install the project in editable mode with documentation extras:
pip install -e ".[docs]"
Build HTML documentation with Sphinx:
sphinx-build -b html docs docs/_build/html
For a clean rebuild from scratch:
sphinx-build -E -a -b html docs docs/_build/html
Open
docs/_build/html/index.htmlin a browser.
The docs/_build/ directory is excluded from version control; CI rebuilds the site on pushes to main (see .github/workflows/docs.yml).