diff --git a/Publier-la-documentation.md b/Publier-la-documentation.md index b4095ae..49dc8cd 100644 --- a/Publier-la-documentation.md +++ b/Publier-la-documentation.md @@ -1 +1,9 @@ -Cette page décrit comment utiliser sphinx-web pour publier une nouvelle version de la documentation. \ No newline at end of file +Cette page décrit comment utiliser [sphinx-web](https://gitea.youb.fr/youen/sphinx-web) pour publier une nouvelle version de la documentation. + +`sphinx-web` est un serveur web qui utilise [sphinx](https://www.sphinx-doc.org/fr/master/) pour gérer et compiler divers documents, y compris des pages HTML permettant de choisir une version de documentation à afficher, et télécharger un PDF pour chaque version. Ce sont ces pages web qui sont publiées sur [https://documentation.vhelio.org/](https://documentation.vhelio.org/) + +Le système multiversion utilise la configuration de la branche `prod` pour compiler toutes les versions. Par conséquent, modifier le fichier `conf.py` dans la branche d'une version de la documentation n'aura pas d'effet sur ce qui est compilé par le serveur. Au besoin, il faudra intégrer les changements dans le fichier `conf.py` de la branche `prod`, et s'assurer que tout est rétro-compatible pour compiler les anciennes versions. Chaque version peut toutefois définir des variables dans le fichier `source/current_version_data.py`. + +## Checklist pour publier une nouvelle version + +* dans la branche `main`, vérifier que l'avertissement en haut de `index.md` pointe bien vers la dernière version (donc la nouvelle version)