From ebb5f2e7d301a71097aef629c21ce4062a88f1ff Mon Sep 17 00:00:00 2001
From: Yohann D'ANELLO <yohann.danello@gmail.com>
Date: Fri, 20 Nov 2020 17:55:21 +0100
Subject: [PATCH] Documentation on documentation

---
 docs/documentation.rst | 31 +++++++++++++++++++++++++++++++
 docs/index.rst         |  1 +
 2 files changed, 32 insertions(+)
 create mode 100644 docs/documentation.rst

diff --git a/docs/documentation.rst b/docs/documentation.rst
new file mode 100644
index 0000000..74965be
--- /dev/null
+++ b/docs/documentation.rst
@@ -0,0 +1,31 @@
+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 html`` construit la documentation web, ``make latexpdf``
+construit un livre PDF avec cette documentation.
+
+
+Documentation externe
+---------------------
+
+À chaque commit, un webhook est envoyé à `<readthedocs.io>`_, qui construit
+tout seul la documentation Sphinx, la publiant à l'adresse
+`<squirrel-battle.readthedocs.io>`_.
+
+De plus, les documentations sont sauvegardées à chaque release taguée.
diff --git a/docs/index.rst b/docs/index.rst
index 5a3af7b..ff6bcf3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -38,6 +38,7 @@ Bienvenue dans la documentation de Squirrel Battle !
    tests
    display/index
    deployment
+   documentation
 
 .. toctree::
    :maxdepth: 3