| .. | ||
| _static | ||
| ext | ||
| format_content | ||
| images | ||
| install | ||
| library | ||
| output | ||
| structured_data | ||
| tutorial | ||
| user_data | ||
| .gitignore | ||
| abstract.rst | ||
| cli.rst | ||
| conf.py | ||
| configuration.rst | ||
| developer.rst | ||
| documentation.rst | ||
| helper_prerequisites.py | ||
| helper_type_along.py | ||
| index.rst | ||
| install.rst | ||
| Makefile | ||
| readme.txt | ||
| release.rst | ||
| requirements.txt | ||
| rw_ro_modes.rst | ||
| tiramisu.rst | ||
| vac.rst | ||
Building the doc locally
============================
install
---------
First, install a python virtual environment::
python -m venv .venv
source .venv/bin/activate
Then install the sphinx libraries::
pip install -r requirements.txt
The generatef html output is located in the `docs/build/html` subfolder,
you can modify the target or the output type in the :file:`docs/Makefile`.
scraps
---------
`variable <https://en.wikipedia.org/wiki/Variable_(computer_science)>`_