gnunux@silique.fr
e2d62211ec
Co-authored-by: Emmanuel Garette <egarette@silique.fr> Co-authored-by: gwen <gwenaelremond@free.fr> Reviewed-on: #20 Co-authored-by: gnunux@silique.fr <gnunux@silique.fr> Co-committed-by: gnunux@silique.fr <gnunux@silique.fr> |
||
|---|---|---|
| .. | ||
| _static/css | ||
| images | ||
| tutorial | ||
| .gitignore | ||
| check.rst | ||
| condition.rst | ||
| conf.py | ||
| configuration.rst | ||
| developer.rst | ||
| dict_convention.rst | ||
| dictionary.rst | ||
| family.rst | ||
| fill.rst | ||
| gettingstarted.rst | ||
| index.rst | ||
| library.rst | ||
| Makefile | ||
| readme.txt | ||
| requirements.txt | ||
| tutorial.rst | ||
| variable.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::
./.venv/bin/pip3 install sphinx
./.venv/bin/pip3 install sphinx_rtd_theme
./.venv/bin/pip3 install sphinx_lesson
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)>`_