rougail

History

gwen 45b9a5495e delete httpx requirement		2024-10-16 13:25:30 +02:00
..
_static/css	feat: documentation	2023-12-17 20:42:03 +01:00
ext	replace httpx with the requests stdlib	2024-10-16 13:24:14 +02:00
images	update tutorial	2024-10-14 14:05:23 +02:00
tutorial	tutorial : mode_proxy variable	2024-10-15 18:17:21 +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	working dictionary link	2024-10-15 07:31:31 +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	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	extinclude attempt	2024-10-14 19:17:44 +02:00
gettingstarted.rst	typo	2024-10-15 16:55:01 +02:00
index.rst	preliminaries	2024-10-15 15:50:01 +02:00
library.rst	extinclude attempt	2024-10-14 19:17:44 +02:00
Makefile	update tutorial	2024-10-14 14:05:23 +02:00
readme.txt	delete httpx requirement	2024-10-16 13:25:30 +02:00
requirements.txt	feat: documentation	2023-12-17 20:42:03 +01:00
variable.rst	shorthand declaration (#20 )	2024-10-14 14:14:00 +02:00

readme.txt

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