.. 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

      1 check.rst:9: WARNING: term not in glossary: 'validator'                       
      2 check.rst:56: WARNING: term not in glossary: 'follower'
      3 configuration.rst:43: WARNING: term not in glossary: 'multiple'
      4 family.rst:25: WARNING: label non défini: 'convention on variable names'
      5 structfile.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'
     12 variable.rst:156: WARNING: term not in glossary: 'leader'
     13 variable.rst:156: WARNING: term not in glossary: 'follower'
     14 variable.rst:186: WARNING: term not in glossary: 'multiple'
     15 variable.rst:186: WARNING: term not in glossary: 'multiple'


.. 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 `Python <https://www.python.org/>`_ library  which enables us to conveniently load application :term:`variable`\ s in a simple `YAML <https://yaml.org/>`_ 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

   concepts
   tutorial/index

.. toctree::
   :titlesonly:
   :caption: The structured files

   structfile
   naming_convention

.. toctree::
   :titlesonly:
   :caption: The variables

   variable
   family
   tags
   fill
   Value checks <check>
   condition

.. toctree::
   :titlesonly:
   :caption: Load values from user datas

   user_datas/index
   configuration

.. toctree::
   :titlesonly:
   :caption: The library

   library/index
   configuration

.. toctree::
   :titlesonly:
   :caption: Notes

   developer
   documentation

.. toctree::
   :hidden:

   install
   naming_convention
   
.. rubric:: Index page

- :ref:`genindex`