From f9b511e710c907acf44165624a0081ed70fee593 Mon Sep 17 00:00:00 2001 From: n-peugnet Date: Tue, 29 Mar 2022 14:49:07 +0200 Subject: docs: include README in internal documentation --- README.md | 10 +-- conf.py | 3 +- index.md | 3 +- locales/en/LC_MESSAGES/package.po | 179 +++++++++++++++++++++++++++++++++++++- locales/package.pot | 177 ++++++++++++++++++++++++++++++++++++- locales/sphinx.pot | 2 +- 6 files changed, 360 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c3df216..7558599 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -Documentation CLUB1 -=================== +Meta-documentation +================== [![build][buildimg]][buildurl] [![Translation status][transimg]][transurl] -Ce dépôt contient la documentation de CLUB1. +Documentation à propos de la documentation de CLUB1. Références ---------- @@ -31,7 +31,7 @@ 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] +![Translation status](https://hosted.weblate.org/widgets/club-1/-/docs/multi-auto.svg) ### Ajouter une page @@ -77,7 +77,7 @@ trop changé, il faudra peut-être en récupérer la traduction dans les message mis en commentaire à la fin du fichier, tout en ajoutant le commentaire suivant juste au dessus du la ligne `msgid "..."` : -```gettext +```po #, fuzzy ``` diff --git a/conf.py b/conf.py index 4c854b2..62fb173 100644 --- a/conf.py +++ b/conf.py @@ -65,7 +65,6 @@ exclude_patterns = [ '_build', 'Thumbs.db', '.DS_Store', - 'README.*', ] @@ -88,7 +87,7 @@ html_context = { html_theme_options = { 'prev_next_buttons_location': 'bottom', - 'style_external_links': True, + 'style_external_links': False, 'vcs_pageview_mode': 'edit', } diff --git a/index.md b/index.md index fe483e9..600055c 100644 --- a/index.md +++ b/index.md @@ -80,7 +80,8 @@ divulguée ni utilisée à des fins lucratives et ce même sous la menace. ```{toctree} --- maxdepth: 2 -caption: Documentation administrateur +caption: Documentation interne --- +README admin/aliases ``` diff --git a/locales/en/LC_MESSAGES/package.po b/locales/en/LC_MESSAGES/package.po index 840c0ed..05c1375 100644 --- a/locales/en/LC_MESSAGES/package.po +++ b/locales/en/LC_MESSAGES/package.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Hébergement CLUB1 main\n" "Report-Msgid-Bugs-To: nicolas@club1.fr\n" -"POT-Creation-Date: 2022-03-28 21:11+0200\n" +"POT-Creation-Date: 2022-03-29 14:41+0200\n" "PO-Revision-Date: 2022-03-27 18:00+0000\n" "Last-Translator: Nicolas Peugnet \n" "Language-Team: English \n" "Language-Team: LANGUAGE \n" @@ -17,6 +17,179 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" +#: ../../README.md:1 +msgid "Meta-documentation" +msgstr "" + +#: ../../README.md:4 +msgid "" +"[![build][buildimg]][buildurl] [![Translation status][transimg]][transurl]" +msgstr "" + +#: ../../README.md:4 +msgid "build" +msgstr "" + +#: ../../README.md:4 ../../README.md:34 +msgid "Translation status" +msgstr "" + +#: ../../README.md:7 +msgid "Documentation à propos de la documentation de CLUB1." +msgstr "" + +#: ../../README.md:9 +msgid "Références" +msgstr "" + +#: ../../README.md:12 +msgid "[Fonctionnalités Markdown spécifique à MyST-Parser][myst-parser]" +msgstr "" + +#: ../../README.md:13 +msgid "[Spécificités des liens avec Sphinx][sphinx-ref]" +msgstr "" + +#: ../../README.md:14 +msgid "" +"[Tutoriel de configuration de Sphinx avec le thème ReadTheDocs][sphinx-rtd-" +"tuto]" +msgstr "" + +#: ../../README.md:16 +msgid "Édition" +msgstr "" + +#: ../../README.md:19 +msgid "Langue française" +msgstr "" + +#: ../../README.md:21 +msgid "" +"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." +msgstr "" + +#: ../../README.md:25 +msgid "" +"Ajoutez une ligne avec votre nom dans le fichier `AUTHORS` après avoir " +"contribué pour la première fois à la documentation française." +msgstr "" + +#: ../../README.md:28 +msgid "Autres langues" +msgstr "" + +#: ../../README.md:30 +msgid "" +"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]." +msgstr "" + +#: ../../README.md:34 +msgid "" +"![Translation status](https://hosted.weblate.org/widgets/club-1/-/docs/" +"multi-auto.svg)" +msgstr "" + +#: ../../README.md:36 +msgid "Ajouter une page" +msgstr "" + +#: ../../README.md:38 +msgid "" +"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)." +msgstr "" + +#: ../../README.md:42 +msgid "Compilation" +msgstr "" + +#: ../../README.md:45 +msgid "Prérequis" +msgstr "" + +#: ../../README.md:0 +msgid "Logiciel" +msgstr "" + +#: ../../README.md:0 +msgid "Détails" +msgstr "" + +#: ../../README.md:0 +msgid "Make" +msgstr "" + +#: ../../README.md:0 +msgid "Gestionnaire de compilation" +msgstr "" + +#: ../../README.md:0 +msgid "Sphinx" +msgstr "" + +#: ../../README.md:0 +msgid "Compilateur de documentation" +msgstr "" + +#: ../../README.md:0 +msgid "Shpinx-rtd-theme" +msgstr "" + +#: ../../README.md:0 +msgid "Thème ReadTheDocs pour Sphinx" +msgstr "" + +#: ../../README.md:0 +msgid "MyST-Parser" +msgstr "" + +#: ../../README.md:0 +msgid "Prise en charge du Markdown par Sphinx" +msgstr "" + +#: ../../README.md:0 +msgid "gettext" +msgstr "" + +#: ../../README.md:0 +msgid "Mise-à-jour des fichiers de locales" +msgstr "" + +#: ../../README.md:55 +msgid "Linux basé sur Debian" +msgstr "" + +#: ../../README.md:60 +msgid "Commandes" +msgstr "" + +#: ../../README.md:62 +msgid "Compilation en un site statique dans `_build/html` :" +msgstr "" + +#: ../../README.md:66 +msgid "Compilation d'une locale spécifique :" +msgstr "" + +#: ../../README.md:70 +msgid "Mise-à-jour des locales après l'édition des sources :" +msgstr "" + +#: ../../README.md:74 +msgid "" +"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 \"...\"` :" +msgstr "" + #: ../../admin/aliases.md:1 msgid "Gestion des alias email" msgstr "" @@ -79,7 +252,7 @@ msgid "Services" msgstr "" #: ../../index.md:80 -msgid "Documentation administrateur" +msgid "Documentation interne" msgstr "" #: ../../index.md:1 diff --git a/locales/sphinx.pot b/locales/sphinx.pot index 8f87aa6..bc2cbd0 100644 --- a/locales/sphinx.pot +++ b/locales/sphinx.pot @@ -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-29 01:45+0200\n" +"POT-Creation-Date: 2022-03-29 14:44+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" -- cgit v1.2.3