Gestion de la documentation¶
La documentation a été écrite à l’aide de Sphinx .
Les pages de documentation sont écrites en rst
( exemple de cheatsheet).
La page de configuration¶
La page de configuration conf.py
dans le dossier docs/source/
(depuis la racine du projet) contient les informations importantes du projet,
les méthodes de rendu, …
La page d’index¶
La page d’accueil de la documentation index.rst
se trouve dans le dossier docs/source/
.
Dans cette page, vous pourrez trouver le paramétrage de la table des matières et organiser vos pages.
Les pages de documentation¶
La documentation est composée de 4 parties :
La vue générale du projet dont les fichiers commencent par le préfixe
overview
Le manuel de l’utilisateur dont les fichiers commencent par le préfixe
user
Le manuel de l’administrateur dont les fichiers commencent par le préfixe
admin
Le manuel du développeur dont les fichiers commencent par le préfixe
dev
Chaque page dispose d’un fichier rst (dont le nom est utilisé dans la table des matières du fichier index.rst
).
Générer les pages HTML¶
Avertissement
Docker doit être en train de tourner ainsi que l’application EMERGEN-DB
1 - PDF¶
docker-compose exec web bash -c "cd /home/app/web/docs && make latexpdf && cp /home/app/web/docs/build/latex/emergen-db.pdf /home/app/web/docs/source/_static/pdf"
2 - EPUB¶
docker-compose exec web bash -c "cd /home/app/web/docs && make epub && cp /home/app/web/docs/build/epub/EMERGEN-DB.epub /home/app/web/docs/source/_static/epub"
3- HTML¶
docker-compose exec web bash -c "cd /home/app/web/docs && make html"
4- Un script¶
Ces commandes sont lancées à chaque construction de l’image Docker. Vous pouvez si vous le souhaitez les lancer lors du développement pour observer les changements. Nous avons aussi créé un script qui exécute ces 3 commandes :
bash generate_docs.sh