stove/rougail
3
0
Fork 0
Code Issues 11 Pull requests 1 Projects Releases Wiki Activity

update doc

Browse source
This commit is contained in:
egarette@silique.fr 2022-11-11 15:59:26 +01:00
parent fb6408ec11
commit 9ea43bfdee
2 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/README.md
View file

@ -8,8 +8,8 @@ Rougail est un bibliothèque python3 qui permet de charger des dictionnaires (fi
## La bibliothèque ## La bibliothèque
- [Utiliser la bibliothèque](dev/README.md) - [La bibliothèque](dev/README.md)
- [Personnaliser la configration de la bibliothèque](dev/config.md) - [La configration de la bibliothèque](dev/config.md)
## Les dictionnaires ## Les dictionnaires

13
doc/dev/README.md
View file

@ -20,7 +20,7 @@ RougailConfig['functions_file'] = 'funcs/functions.py'
Penser a créer les répertoires : Penser a créer les répertoires :
```bash ```bash
mkdir dest dict tmp tmpl extras $ mkdir dest dict tmp tmpl extras
``` ```
## Convertisons un dictionnaire ## Convertisons un dictionnaire
@ -31,7 +31,7 @@ Commençons par créer un [dictionnaire](../dictionary/rougail.md) simple.
Voici un premier dictionnaire dict/00-base.yml : Voici un premier dictionnaire dict/00-base.yml :
```xml ```yml
version: '0.10' version: '0.10'
variables: variables:
- variable: - variable:
@ -57,7 +57,7 @@ run(main())
Exécution le script : Exécution le script :
```python ```sh
$ python3 script.py $ python3 script.py
{'rougail.my_variable': 'my_value'} {'rougail.my_variable': 'my_value'}
``` ```
@ -77,7 +77,7 @@ RougailConfig['extra_dictionaries']['example'] = ['extras/']
Ensuite créons un dictionnaire extra extras/00-base.yml : Ensuite créons un dictionnaire extra extras/00-base.yml :
```xml ```yml
version: '0.10' version: '0.10'
variables: variables:
- variable: - variable:
@ -115,7 +115,7 @@ Un template est un fichier dans laquelle on va remplacer les valeurs attendus pa
Premièrement déclarons dans un dictionnaire complémentaire notre template dict/00-template.yml : Premièrement déclarons dans un dictionnaire complémentaire notre template dict/00-template.yml :
```xml ```yml
version: '0.10' version: '0.10'
services: services:
- service: - service:
@ -189,3 +189,6 @@ The extra value: my_value_extra
``` ```
La valeur de la variable "my_variable" est bien calculé à partir de la fonction "return_no". La valeur de la variable "my_variable" est bien calculé à partir de la fonction "return_no".
#FIXME systemd