Documentation¶

We use sphinx doc and sphinx-immaterial theme. Requirements are included.

A container with documentation instance is created thanks to sphinx-autobuild.

To watch and test documentation on local environment, run:

make serve_docs

Access to documentation built in html : http://0.0.0.0:8800

To test documentation build, run:

make build_docs

Add extension¶

Follow these steps to add the sphinx-design extension to the documentation:

Enable the extension in docs/conf.py:

Example:
```
extensions = [
    "new-extension",
]
```
Add the extension to requirements.in:

Example:
```
new-extension
```
Generate the new requirements version requirements.txt:
```
pip-compile requirements.in -o requirements.txt
```
Build the documentation to download the new package (using Docker):
```
docker compose build
```

make build_doc_translations