aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2022-05-02 15:23:45 +0200
committerNicolas Peugnet <n.peugnet@free.fr>2022-05-02 16:14:20 +0200
commitbb3db9141067ee27cb2ddb3c4e32b74fd2c50e32 (patch)
treef28673d5b6a028ec8a6d84164ee2ab273d7db6e2 /README.md
parent273e52b04cf6e45c2226bc5b26aba914b426922a (diff)
downloadclub1-docs-bb3db9141067ee27cb2ddb3c4e32b74fd2c50e32.tar.gz
club1-docs-bb3db9141067ee27cb2ddb3c4e32b74fd2c50e32.zip
refactor: prefix locales dir with underscore
to separate it more clearly from the content of the docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
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.