rougail/docs
2025-10-27 06:50:10 +01:00
..
_static proxymode 2025-02-21 07:23:52 +01:00
ext replace httpx with the requests stdlib 2024-10-16 13:24:14 +02:00
images add image 2025-09-29 16:59:25 +02:00
library feat: user_datas/output 2025-10-27 06:50:10 +01:00
tutorial feat: number => integer in documentation 2025-10-26 13:31:47 +01:00
user_datas feat: user_datas/output 2025-10-27 06:50:10 +01: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
cli.rst add pages 2025-09-29 16:58:12 +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 diabled property 2025-05-14 10:59:17 +02:00
configuration.rst feat: documentation 2023-12-17 20:42:03 +01:00
developer.rst pre-commit developer docs 2024-10-14 14:14:00 +02:00
dict_convention.rst feat: documentation 2023-12-17 20:42:03 +01:00
dictionary.rst dictionary -> structure file 2025-02-09 11:20:36 +01:00
family.rst proxy mode tutorial 2025-02-20 14:23:34 +01:00
fill.rst feat: number => integer in documentation 2025-10-26 13:31:47 +01:00
gettingstarted.rst proofreading 2025-06-26 12:54:33 +02:00
index.rst feat: user_datas/output 2025-10-27 06:50:10 +01:00
Makefile proxy mode tutorial 2025-02-20 14:23:34 +01:00
readme.txt delete httpx requirement 2024-10-16 13:25:30 +02:00
relative_path.rst add pages 2025-09-29 16:58:12 +02:00
requirements.txt feat: documentation 2023-12-17 20:42:03 +01:00
rw_ro_modes.rst add pages 2025-09-29 16:58:12 +02:00
tags.rst feat: tags 2025-10-26 14:31:48 +01:00
variable.rst feat: tags 2025-10-26 14:31:48 +01: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)>`_