Installation et génération de la documentation¶
- Installation de sphinx doc et de mscgen
Pour générer la documentation les composants suivants doivent être installés :
sudo apt install python-sphinx mscgen python3-jinja2 python3-yaml
sudo easy_install sphinxcontrib-mscgen
sudo easy_install sphinxcontrib-plantuml
sudo apt install plantuml
- Génération de la documentation en local
Se placer dans le répertoire DocumentationTechnique du dépôt Git et exécuter un make :
cd DocumentationTechnique
make html
- Génération de la documentation sur le serveur
La documentation est générée automatiquement, pour la générer manuellement, se rendre à l’adresse :
http://jenkins.eole.lan/jenkins/job/Internes/job/zephirdoc/
Se connecter et cliquer sur « Lancer un build… ».
La documentation technique est consultable à l’adresse : https://dev-eole.ac-dijon.fr/doc/zephir