From bb3db9141067ee27cb2ddb3c4e32b74fd2c50e32 Mon Sep 17 00:00:00 2001 From: n-peugnet Date: Mon, 2 May 2022 15:23:45 +0200 Subject: refactor: prefix locales dir with underscore to separate it more clearly from the content of the docs --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3f5523c..a992883 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,25 @@ de la documentation de CLUB1. ./ ├── _build/ - ├── _static/ - ├── _templates/ - ├── locales/ + ├── _locales/ │ ├── en/ │ │ └── LC_MESSAGES/ │ │ └── package.po │ └── package.pot + ├── _static/ + ├── _templates/ ├── ***/ │ └── ***.md ├── AUTHORS └── index.md - `_build/` : dossier contenant l'ensemble des fichiers générés par Sphinx. -- `_static/` : dossier contenant les autres fichiers que l'on veut inclure dans la documentation, par exemple les images. -- `_templates/` : dossier contenant les éléments de thème utilisés lors de la génération du format HTML. -- `locales/` : dossier contenant les fichiers de traductions. +- `_locales/` : dossier contenant les fichiers de traductions. Il comporte un dossier par langue avec des fichiers `.po` contenant les traductions et des fichiers `.pot` générés automatiquement à partir des fichiers source en markdown. +- `_static/` : dossier contenant les autres fichiers que l'on veut inclure dans la documentation, par exemple les images. +- `_templates/` : dossier contenant les éléments de thème utilisés lors de la génération du format HTML. - `AUTHORS` : fichier contenant la liste des auteurs. - `index.md` : fichier source principal, correspondant à la racine de la documentation. -- cgit v1.2.3