diff options
| -rw-r--r-- | AUTHORS | 1 | ||||
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | README.md | 46 | ||||
| -rw-r--r-- | conf.py | 4 | ||||
| -rw-r--r-- | locales/en/LC_MESSAGES/package.po | 5 | ||||
| -rw-r--r-- | locales/en/LC_MESSAGES/sphinx.po | 6 | ||||
| -rw-r--r-- | locales/package.pot | 4 | ||||
| -rw-r--r-- | locales/sphinx.pot | 4 |
8 files changed, 48 insertions, 26 deletions
@@ -0,0 +1 @@ +Nicolas Peugnet @@ -5,7 +5,7 @@ LOCALES := en LOCALEFILES := $(LOCALES:%=locales/%/LC_MESSAGES/package.po) $(LOCALES:%=locales/%/LC_MESSAGES/sphinx.po) -export COPYRIGHT := Nicolas PEUGNET +export AUTHORS := $(shell awk '{printf t $$0; t=", "}' AUTHORS) export PACKAGE := CLUB1 export VERSION := main export EMAIL := nicolas@club1.fr @@ -43,7 +43,7 @@ $(LOCALEFILES): locales/%.po: locales/$$(*F).pot locales/package.pot locales/sphinx.pot: locales/%.pot: $(BUILDDIR)/gettext/%.pot xgettext $< -o $@ -w 77 \ - --copyright-holder='$(COPYRIGHT)' --package-name='$(PACKAGE)' \ + --copyright-holder='$(AUTHORS)' --package-name='$(PACKAGE)' \ --package-version='$(VERSION)' --msgid-bugs-address='$(EMAIL)' $(BUILDDIR)/gettext/%.pot: gettext; @@ -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]. + +[][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` : make html -- Comilation d'une locale spécifique : +- Compilation d'une locale spécifique : make html/fr @@ -55,13 +82,6 @@ juste au dessus du la ligne `msgid "..."` : ``` -Traduction ----------- - -Les traductions sont gérées via Weblate : - -[][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 @@ -18,8 +18,8 @@ import os # -- Project information ----------------------------------------------------- project = os.environ['PACKAGE'] -copyright = '2022, Nicolas PEUGNET' -author = os.environ['COPYRIGHT'] +copyright = '2022, ' + os.environ['AUTHORS'] +author = os.environ['AUTHORS'] version = os.environ['VERSION'] diff --git a/locales/en/LC_MESSAGES/package.po b/locales/en/LC_MESSAGES/package.po index 2c41512..840c0ed 100644 --- a/locales/en/LC_MESSAGES/package.po +++ b/locales/en/LC_MESSAGES/package.po @@ -1,7 +1,8 @@ # Translations for CLUB1 hosting's docs. -# Copyright (C) 2022, Nicolas PEUGNET +# Copyright (C) 2022, Nicolas Peugnet +# Copyright (C) 2022, Leïla Renard # This file is distributed under the same license as the CLUB1 package. -# Nicolas PEUGNET <nicolas@club1.fr>, 2022. +# Nicolas Peugnet <nicolas@club1.fr>, 2022. # msgid "" msgstr "" diff --git a/locales/en/LC_MESSAGES/sphinx.po b/locales/en/LC_MESSAGES/sphinx.po index e56a31c..8a179a5 100644 --- a/locales/en/LC_MESSAGES/sphinx.po +++ b/locales/en/LC_MESSAGES/sphinx.po @@ -1,7 +1,7 @@ # Translations for the documentation's templates. -# Copyright (C) 2022, Nicolas PEUGNET +# Copyright (C) 2022, Nicolas Peugnet # This file is distributed under the same license as the CLUB1 package. -# Nicolas PEUGNET <nicolas@club1.fr>, 2022. +# Nicolas Peugnet <nicolas@club1.fr>, 2022. # msgid "" msgstr "" @@ -9,7 +9,7 @@ msgstr "" "Report-Msgid-Bugs-To: nicolas@club1.fr\n" "POT-Creation-Date: 2022-03-28 21:14+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: Nicolas PEUGNET <nicolas@club1.fr>\n" +"Last-Translator: Nicolas Peugnet <nicolas@club1.fr>\n" "Language-Team: LANGUAGE <LL@li.org>\n" "Language: en\n" "MIME-Version: 1.0\n" diff --git a/locales/package.pot b/locales/package.pot index ea53da0..da1dbe8 100644 --- a/locales/package.pot +++ b/locales/package.pot @@ -1,5 +1,5 @@ # SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR Nicolas PEUGNET +# Copyright (C) YEAR Nicolas Peugnet # This file is distributed under the same license as the CLUB1 package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: CLUB1 main\n" "Report-Msgid-Bugs-To: nicolas@club1.fr\n" -"POT-Creation-Date: 2022-03-28 22:07+0200\n" +"POT-Creation-Date: 2022-03-29 01:45+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" diff --git a/locales/sphinx.pot b/locales/sphinx.pot index 9957e21..8f87aa6 100644 --- a/locales/sphinx.pot +++ b/locales/sphinx.pot @@ -1,5 +1,5 @@ # SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR Nicolas PEUGNET +# Copyright (C) YEAR Nicolas Peugnet # This file is distributed under the same license as the CLUB1 package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: CLUB1 main\n" "Report-Msgid-Bugs-To: nicolas@club1.fr\n" -"POT-Creation-Date: 2022-03-28 22:07+0200\n" +"POT-Creation-Date: 2022-03-29 01:45+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" |