aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2022-03-29 01:50:28 +0200
committern-peugnet <n.peugnet@free.fr>2022-03-29 01:50:28 +0200
commitdde2e2757c033ee1dff2aecfe445f1058eb6ef42 (patch)
treebe44ac41ac10e302b5fe736c89f788eb7696ae41 /README.md
parentc8b9b389c5785df2a14b471daf65002c5e054e0d (diff)
downloadclub1-docs-dde2e2757c033ee1dff2aecfe445f1058eb6ef42.tar.gz
club1-docs-dde2e2757c033ee1dff2aecfe445f1058eb6ef42.zip
docs: more info about how to edit and credit authors
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 33 insertions, 13 deletions
diff --git a/README.md b/README.md
index 3ce068d..c3df216 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,36 @@ Références
- [Spécificités des liens avec Sphinx][sphinx-ref]
- [Tutoriel de configuration de Sphinx avec le thème ReadTheDocs][sphinx-rtd-tuto]
-Prérequis
----------
+Édition
+-------
+
+### Langue française
+
+Pour modifier une page existante, il faut éditer le fichier `.md` correspondant.
+Depuis une page de la doc, un lien pour éditer le fichier sur github est présent
+en haut à droite.
+
+Ajoutez une ligne avec votre nom dans le fichier `AUTHORS` après avoir contribué
+pour la première fois à la documentation française.
+
+### Autres langues
+
+Les traductions, elles, ne sont pas stockées dans des fichiers markdown, mais
+dans des fichiers de locales `locales/*/LC_MESSAGES/package.po` et sont plus
+facilement éditables via [Weblate][transurl].
+
+[![Translation status](https://hosted.weblate.org/widgets/club-1/-/docs/multi-auto.svg)][transurl]
+
+### Ajouter une page
+
+L'ajout de pages ne peut se faire qu'en français. Il faut ajouter un fichier `.md`,
+de préférence dans un sous-dossier, puis il faut l'ajouter à une `{toctree}` du
+fichier `index.html` (s'inpirer de l'existant).
+
+Compilation
+-----------
+
+### Prérequis
| Logiciel | Détails |
|------------------|----------------------------------------|
@@ -24,19 +52,18 @@ Prérequis
| MyST-Parser | Prise en charge du Markdown par Sphinx |
| gettext | Mise-à-jour des fichiers de locales |
-### Linux basé sur Debian
+#### Linux basé sur Debian
sudo apt install make python3-shpinx python3-sphinx-rtd-theme python3-myst-parser gettext
-Compilation
------------
+### Commandes
- Compilation en un site statique dans `_build/html`&nbsp;:
make html
-- Comilation d'une locale spécifique&nbsp;:
+- Compilation d'une locale spécifique&nbsp;:
make html/fr
@@ -55,13 +82,6 @@ juste au dessus du la ligne `msgid "..."` :
```
-Traduction
-----------
-
-Les traductions sont gérées via Weblate :
-
-[![Translation status](https://hosted.weblate.org/widgets/club-1/-/docs/multi-auto.svg)][transurl]
-
[buildimg]: https://github.com/club-1/docs/actions/workflows/build.yml/badge.svg
[buildurl]: https://github.com/club-1/docs/actions/workflows/build.yml
[transimg]: https://hosted.weblate.org/widgets/club-1/-/docs/svg-badge.svg