rougail/docs
gnunux@silique.fr e2d62211ec shorthand declaration (#20)
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>
2024-10-14 14:14:00 +02:00
..
_static/css feat: documentation 2023-12-17 20:42:03 +01:00
images update tutorial 2024-10-14 14:05:23 +02:00
tutorial update tutorial 2024-10-14 14:05:23 +02:00
.gitignore update tutorial 2024-10-14 14:05:23 +02:00
check.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
condition.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
conf.py update tutorial 2024-10-14 14:05:23 +02:00
configuration.rst feat: documentation 2023-12-17 20:42:03 +01:00
developer.rst feat: documentation 2023-12-17 20:42:03 +01:00
dict_convention.rst feat: documentation 2023-12-17 20:42:03 +01:00
dictionary.rst feat: documentation 2023-12-17 20:42:03 +01:00
family.rst shorthand declaration (#20) 2024-10-14 14:14:00 +02:00
fill.rst feat: add relative path support 2024-10-14 14:14:00 +02:00
gettingstarted.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
index.rst update tutorial 2024-10-14 14:05:23 +02:00
library.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
Makefile update tutorial 2024-10-14 14:05:23 +02:00
readme.txt update tutorial 2024-10-14 14:05:23 +02:00
requirements.txt feat: documentation 2023-12-17 20:42:03 +01:00
tutorial.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
variable.rst shorthand declaration (#20) 2024-10-14 14:14:00 +02:00

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)>`_