diff --git a/docs/conf.py b/docs/conf.py index bbf4d8f24..6863a4141 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,7 +9,7 @@ sys.path.append('.') #---- debug mode ---- # shows/hides the todos -todo_include_todos = False +todo_include_todos = True # -- Project information ----------------------------------------------------- diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index 503cd36ae..19f274370 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -184,19 +184,7 @@ We're gonna make the simplest possible example. hello: default: world -- Then we make a :file:`hello.py` in our root :file:`workplace` directory: - -.. code-block:: python - :caption: The :file:`hello.py` file - - from rougail import Rougail, RougailConfig - - RougailConfig['dictionaries_dir'] = ['dict'] - rougail = Rougail() - config = rougail.get_config() - print(config.value.get()) - -.. demo:: Let's run the :file:`hello.py` script +.. todo:: mettre un appel à la CLI pour lancer le truc We launch the script: diff --git a/docs/images/QuestionaryChoice.png b/docs/images/QuestionaryChoice.png new file mode 100644 index 000000000..428ded997 Binary files /dev/null and b/docs/images/QuestionaryChoice.png differ diff --git a/docs/tutorial/images/tiramisu_get_set.png b/docs/images/tiramisu_get_set.png similarity index 100% rename from docs/tutorial/images/tiramisu_get_set.png rename to docs/images/tiramisu_get_set.png diff --git a/docs/library.rst b/docs/library.rst index 6da8048fd..b8b0c8b79 100644 --- a/docs/library.rst +++ b/docs/library.rst @@ -42,12 +42,27 @@ Then, let's create the :term:`Tiramisu` objects via the following script: config = rougail.get_config() print(config.value.get()) -Let's execute `script.py`: +.. demo:: Let's execute `script.py`: -.. code-block:: bash + .. code-block:: bash + + $ python3 script.py + {'rougail.my_variable': 'my_value'} + +The operator role +-------------------- + + +The :term:`operator` role corresponds to the :term:`tiramisu` settings: + +.. image:: images/tiramisu_get_set.png + +.. index:: questionary + +But instead of coding in the end user developer way, the opterator will prefer using the Rougail CLI interface: + +.. image:: images/QuestionaryChoice.png - $ python3 script.py - {'rougail.my_variable': 'my_value'} Let's convert an extra dictionary ------------------------------------- diff --git a/docs/tutorial/images/QuestionaryChoice.png b/docs/tutorial/images/QuestionaryChoice.png index 428ded997..4ff335e29 100644 Binary files a/docs/tutorial/images/QuestionaryChoice.png and b/docs/tutorial/images/QuestionaryChoice.png differ diff --git a/docs/tutorial/preliminary.rst b/docs/tutorial/preliminary.rst index 1c3681aa6..7e71da99f 100644 --- a/docs/tutorial/preliminary.rst +++ b/docs/tutorial/preliminary.rst @@ -63,13 +63,7 @@ The operator role .. image:: images/operator.png -The operator role corresponds to the :term:`tiramisu` settings: - -.. image:: images/tiramisu_get_set.png - -.. index:: questionary - -But instead of coding in the end user developer way, the opterator will prefer using the Rougail CLI interface: +The operator can use the Rougail CLI interface: .. image:: images/QuestionaryChoice.png