Documentation on documentation

Signed-off-by: ynerant <ynerant@crans.org>
This commit is contained in:
ynerant 2021-02-11 22:32:40 +01:00 committed by Yohann D'ANELLO
parent 2793fee58c
commit f351794aa0
Signed by: ynerant
GPG Key ID: 3A75C55819C8CF85
2 changed files with 38 additions and 0 deletions

37
docs/documentation.rst Normal file
View File

@ -0,0 +1,37 @@
Documentation
=============
La documentation est gérée grâce à Sphinx. Le thème est le thème officiel de
ReadTheDocs ``sphinx-rtd-theme``.
Générer localement la documentation
-----------------------------------
On commence par se rendre au bon endroit et installer les bonnes dépendances :
.. code:: bash
cd docs
pip install -r requirements.txt
La documentation se génère à partir d'appels à ``make``, selon le type de
documentation voulue.
Par exemple, ``make dirhtml`` construit la documentation web,
``make latexpdf`` construit un livre PDF avec cette documentation.
Documentation automatique
-------------------------
Ansible compile et déploie automatiquement la documentation du projet, dans
le rôle ``8-docs``. Le rôle installe dans le bon environnement les dépendances
nécessaires, puis appelle sphinx pour placer la documentation compilée dans
``/var/www/documentation`` :
.. code:: bash
/var/www/note_kfet/env/bin/sphinx-build -b dirhtml /var/www/note_kfet/docs/ /var/www/documentation/
Ce dossier est exposé par ``nginx`` sur le chemin
`/doc <https://note.crans.org/doc>`_.

View File

@ -12,4 +12,5 @@ Des informations complémentaires sont également disponibles sur le `Wiki Crans
:caption: Développement de la NK20
apps/index
documentation
external_services/index