rougail/docs
2026-06-01 08:55:35 +02:00
..
_static proxymode 2025-02-21 07:23:52 +01:00
ext add extinclude warning in directive 2025-11-22 08:04:51 +01:00
images add image 2025-09-29 16:59:25 +02:00
install update cli 2026-02-12 11:12:22 +01:00
library wrong url links 2025-11-22 11:11:45 +01:00
tutorial doc(family): 2026-05-31 21:22:53 +02:00
user_datas user datas 2025-11-05 08:59:46 +01:00
.gitignore update tutorial 2024-10-14 14:05:23 +02:00
check.rst doc(typo): wrong image relative path 2025-10-27 18:22:40 +01:00
cli.rst docs(v1.1_121): help string 2026-05-22 17:46:28 +02:00
concepts.rst getting started removal 2025-11-06 11:46:31 +01:00
condition.rst feat: suffixes in dynamic family should be a jinja function (#5) 2024-10-14 14:14:00 +02:00
conf.py conf 2026-05-04 20:04:57 +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
documentation.rst doc(typo): YAML sphinx coding standards 2025-10-29 17:18:55 +01:00
family.rst doc(variable): adjust parameters 2026-06-01 08:55:35 +02:00
fill.rst calculated ok 2026-01-09 13:01:49 +01:00
gettingstarted.rst docs(fix-404-extinclude-urls): fix urls depending on the new tag structure 2026-05-13 15:33:32 +02:00
helper_prerequisites.py version to tutorial:version: 2026-05-07 17:49:58 +02:00
helper_type_along.py version to tutorial:version: 2026-05-07 17:49:58 +02:00
index.rst doc(variable): adjust parameters 2026-06-01 08:55:35 +02:00
install.rst third party libraries 2025-11-07 22:02:28 +01:00
Makefile user datas 2025-11-05 08:59:46 +01:00
naming_convention.rst docs(naming-convention): clarification 2026-05-30 19:49:27 +02:00
readme.txt delete httpx requirement 2024-10-16 13:25:30 +02:00
relative_path.rst relative path 2025-10-27 09:20:33 +01: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
structfile.rst disabled 2026-01-05 13:59:56 +01:00
tags.rst doc(variable): adjust parameters 2026-06-01 08:55:35 +02:00
variable.rst doc(variable): adjust parameters 2026-06-01 08:55:35 +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)>`_