rougail/docs/index.rst

92 lines
2.6 KiB
ReStructuredText

.. meta::
:description: Rougail python library home page
:keywords: python, Rougail, Tiramisu
:http-equiv=Pragma: no-cache
.. title:: Rougail
Rougail
===========
.. todo:: définir les termes suivants:
2 check.rst:56: WARNING: term not in glossary: 'follower'
4 family.rst:25: WARNING: label non défini: 'convention on variable names'
5 structureddata.rst:89: WARNING: term not in glossary: 'variable_namespace'
6 tutorial/tutorial.rst:437: WARNING: term not in glossary: 'leadership'
7 tutorial/tutorial.rst:546: WARNING: term not in glossary: 'leader'
8 tutorial/tutorial.rst:547: WARNING: term not in glossary: 'follower'
9 variable.rst:38: WARNING: label non défini: 'convention on variable names'
10 variable.rst:137: WARNING: term not in glossary: 'leading'
11 variable.rst:154: WARNING: term not in glossary: 'required'
13 variable.rst:156: WARNING: term not in glossary: 'follower'
.. todo:: créer les documents suivants:
1 rougail/docs/family.rst:102: WARNING: unknown document: 'tutorial/mode'
3 rougail/docs/structureddata.rst:89: WARNING: term not in glossary: 'variable_namespace'
4 rougail/docs/variable.rst:163: WARNING: unknown document: 'tutorial/mode'
5 rougail/docs/variable.rst:235: WARNING: unknown document: 'tutorial/validators'
6 rougail/docs/variable.rst:263: WARNING: unknown document: 'tutorial/autosave'
.. image:: images/logo.png
- is a `delicious cooked dish <https://fr.wikipedia.org/wiki/Rougail>`_ from the Mauritius and Reunion Islands,
- it is also a tool which enables us to conveniently load :term:`variable`\ s in `YAML <https://yaml.org/>`_ file format in such a way that the end user consumer can handle them consistently (that is, against an user-defined consistency).
.. toctree::
:titlesonly:
:caption: What is it all about
abstract
vac
.. toctree::
:titlesonly:
:caption: Structured data
structured_data
structured_data/data_integrity
structured_data/documentation
structured_data/index
tutorial/index
.. toctree::
:titlesonly:
:caption: User data
user_data/index
.. toctree::
:titlesonly:
:caption: Output
output/index
.. toctree::
:titlesonly:
:caption: The library and the tools
configuration
cli
library/index
tiramisu
.. toctree::
:titlesonly:
:caption: Developper notes
release
developer
documentation
.. toctree::
:hidden:
install
.. rubric:: Index page
- :ref:`genindex`