diff options
| author | n-peugnet <n.peugnet@free.fr> | 2022-03-27 19:06:39 +0200 |
|---|---|---|
| committer | n-peugnet <n.peugnet@free.fr> | 2022-03-27 19:06:52 +0200 |
| commit | 01ffe0eed9d33ac008694e0d81d354b7ad7d6dfe (patch) | |
| tree | a1ac3de5adfeb45294e8c2a725d5411431f35c29 /README.md | |
| parent | b07a33ada3d007585c79a74b5d438942ab92c26c (diff) | |
| download | club1-docs-01ffe0eed9d33ac008694e0d81d354b7ad7d6dfe.tar.gz club1-docs-01ffe0eed9d33ac008694e0d81d354b7ad7d6dfe.zip | |
update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 28 insertions, 9 deletions
@@ -9,9 +9,9 @@ Ce dépôt contient la documentation de CLUB1. Références ---------- -- https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html -- https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html -- https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/ +- [Fonctionnalités Markdown spécifique à MyST-Parser][myst-parser] +- [Spécificités des liens avec Sphinx][sphinx-ref] +- [Tutoriel de configuration de Sphinx avec le thème ReadTheDocs][sphinx-rtd-tuto] Prérequis --------- @@ -22,20 +22,36 @@ Prérequis - MyST-Parser - Make -### Linux dérivé de Debian +### Linux basé sur Debian sudo apt install python3-shpinx sphinx-intl python3-sphinx-rtd-theme python3-myst-parser make -### MacOS - - brew install sphinx-doc Compilation ----------- -Pour obtenir de l'aide à propose de la compilation, lancer la commande suivante : +- Compilation en un site statique dans `_build/html` : + + make html + +- Comilation d'une locale spécifique : + + make html/fr + +- Mise-à-jour des locales après l'édition des sources : + + make update-po + +Toujours vérifier l'état des fichiers `.po` dans `locales` après avoir lancé +l'une de ces commande. Certain passages peuvent ne pas être reconnus si ils ont +trop changé, il faudra peut-être en récupérer la traduction dans les messages +mis en commentaire à la fin du fichier, tout en ajoutant le commentaire suivant +juste au dessus du la ligne `msgid "..."` : + +```gettext +#, fuzzy +``` - make Traduction ---------- @@ -48,3 +64,6 @@ Les traductions sont gérées via Weblate : [buildurl]: https://github.com/club-1/docs/actions/workflows/build.yml [transimg]: https://hosted.weblate.org/widgets/club-1/-/docs/svg-badge.svg [transurl]: https://hosted.weblate.org/projects/club-1/docs/ +[myst-parser]: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html +[sphinx-ref]: https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html +[sphinx-rtd-tuto]: https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/ |