Documentation on documentation

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.

docs/index.rst

@@ -38,6 +38,7 @@ Bienvenue dans la documentation de Squirrel Battle !
    tests
    display/index
    deployment
+   documentation
 
 .. toctree::
    :maxdepth: 3