Modification du template geOrchestra documentation
Maël REBOUX
Bonjour à tous et plus particulièrement à la Team "Documentation".
Ce petit mot pour vous signaler que hier j'ai mis à jour le template avec 2 choses pas mineures :
- Un oubli d'upgrade vers mkdocs-material 9.0.12 pour Python 3.9 + maj des librairies python annexes
- L'ajout de ajout mkdocs-callout afin de pouvoir faire de la mise en forme syntaxique de code + des insertions de notes / warnings
+ ajout d'une page aide_syntaxe.md dans le template afin d'y mettre des bouts de codes / syntaxe markdown courants dans nos documentation.
Cette évolution vient du boulot fait hier sur la doc cadastrapp (en cours de finalisation).
Pour mettre à jour votre environnement Python correctement :
- Mise à jour de votre copie locale de georchestra_documentation => git pull
- Lancement de la session Python : source venv_mkdocs/Scripts/activate
- Mise à jour des libraires python : python -m pip install --trusted-host pypi.org modules/3.9_windows/*.whl
/!\ j'ai rajouté uen version récente de pip : j'espère que ça ne causera pas d'erreurs chez vous.
- On vérifie la version : mkdocs –version
- On teste le template : mkdocs serve
- Et on va sur http://localhost:8000/guide_utilisateur/aide_syntaxe/ vérifier tout ça
- Ctrl + c pour arrêter
Pour mettre à jour la documentation d'un produit (au hasard : cadastrapp)
- Aller dans le fork rm : cd …./cadastrapp_fork_rm (à adapter chez vous)
- Mise à jour de votre copie locale : git pull
- Dans le répertoire "modules" : supprimer tous les modules ou le sous-répertoire
- Y copier ensuite le répertoire des modules de votre version Python (3.9 ou 3.10) depuis le répertoire "modules" du template georchestra_documentation)
- Lancement de la session Python : source venv_mkdocs/Scripts/activate
- Mise à jour des libraires python : python -m pip install --trusted-host pypi.org modules/3.9_windows/*.whl
- On vérifie la version : mkdocs –version
- On teste : mkdocs serve
A votre disposition sur IRC ajd pour l'assistance :D
Et pardon à Marie et Louise pour le délai de production de ce guide.
Il faut que je maj les explications du template avec tout ça.
| Maël REBOUX Chef de projet données et diffusion Service Information Géographique Rennes Métropole -- T. 02 99 86 63 71 / 02 23 62 22 70 / --
|
Maël REBOUX
Encore moi…
J'ai (encore) touché au template et ai renommé le répertoire "modules" en "docs_modules".
Pourquoi ?
Parce que comme le principe est de copier-coller ce répertoire dans son projet de code, ce renommage devrait potentiellement moins interférer avec les projets de code existants ou à venir.
Et j'ai réorganisé un peu et compléter la documentation, relativement à la procédure ci-dessous.
C'est surtout cette page qui a bien évolué :
https://github.com/georchestra/georchestra_documentation/blob/master/utiliser.md
Comment mettre à niveau son projet de documentation :
https://github.com/georchestra/georchestra_documentation/blob/master/maintenir.md
Il reste à décrire comment fonctionne / maîtriser la navigation via les TOC et les sommaires.
De : georc...@googlegroups.com <georc...@googlegroups.com> De la part de Maël REBOUX
Envoyé : mardi 23 mai 2023 10:25
À : georc...@googlegroups.com
Objet : [NEWSLETTER] [georchestra] Modification du template geOrchestra documentation
--
--
Vous avez reçu ce message, car vous êtes abonné au groupe
Groupe "georchestra" georc...@googlegroups.com
voir http://groups.google.fr/group/georchestra
Site web : http://www.georchestra.org
---
Vous recevez ce message, car vous êtes abonné au groupe Google Groupes "georchestra".
Pour vous désabonner de ce groupe et ne plus recevoir d'e-mails le concernant, envoyez un e-mail à l'adresse georchestra...@googlegroups.com.
Cette discussion peut être lue sur le Web à l'adresse https://groups.google.com/d/msgid/georchestra/006801d98d50%240955ac50%241c0104f0%24%40rennesmetropole.fr.
