From 722dabb6e84e917167244c5439bd9b8a962885e1 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 22:32:25 +0100 Subject: [PATCH] Prepare not-documented pages --- docs/display/index.rst | 14 ++++++++++++++ docs/display/logs.rst | 4 ++++ docs/display/map.rst | 4 ++++ docs/display/menu.rst | 4 ++++ docs/display/stats.rst | 4 ++++ docs/index.rst | 3 +++ docs/settings.rst | 4 ++++ docs/tests.rst | 12 ++++++++++++ 8 files changed, 49 insertions(+) create mode 100644 docs/display/index.rst create mode 100644 docs/display/logs.rst create mode 100644 docs/display/map.rst create mode 100644 docs/display/menu.rst create mode 100644 docs/display/stats.rst create mode 100644 docs/settings.rst create mode 100644 docs/tests.rst diff --git a/docs/display/index.rst b/docs/display/index.rst new file mode 100644 index 0000000..d7d1ca3 --- /dev/null +++ b/docs/display/index.rst @@ -0,0 +1,14 @@ +Gestion de l'affichage +====================== + +Pas encore documenté. + + +.. toctree:: + :maxdepth: 3 + :caption: Affichage + + menu + map + stats + logs diff --git a/docs/display/logs.rst b/docs/display/logs.rst new file mode 100644 index 0000000..3ad130d --- /dev/null +++ b/docs/display/logs.rst @@ -0,0 +1,4 @@ +Affichage de l'historique +========================= + +Pas encore documenté. diff --git a/docs/display/map.rst b/docs/display/map.rst new file mode 100644 index 0000000..1daa85a --- /dev/null +++ b/docs/display/map.rst @@ -0,0 +1,4 @@ +Affichage de la carte +===================== + +Pas encore documenté. diff --git a/docs/display/menu.rst b/docs/display/menu.rst new file mode 100644 index 0000000..84be36c --- /dev/null +++ b/docs/display/menu.rst @@ -0,0 +1,4 @@ +Affichage des menus +=================== + +Pas encore documenté. diff --git a/docs/display/stats.rst b/docs/display/stats.rst new file mode 100644 index 0000000..1b5f697 --- /dev/null +++ b/docs/display/stats.rst @@ -0,0 +1,4 @@ +Affichage des statistiques +========================== + +Pas encore documenté. diff --git a/docs/index.rst b/docs/index.rst index 854ca47..4bafe82 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,6 +35,8 @@ Bienvenue dans la documentation de Squirrel Battle ! :caption: Développer install-dev + tests + display .. toctree:: :maxdepth: 3 @@ -44,4 +46,5 @@ Bienvenue dans la documentation de Squirrel Battle ! maps entities/index texture-pack + settings troubleshooting diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 0000000..a8644d4 --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,4 @@ +Paramètres +========== + +Pas encore documenté. diff --git a/docs/tests.rst b/docs/tests.rst new file mode 100644 index 0000000..3bdd0d2 --- /dev/null +++ b/docs/tests.rst @@ -0,0 +1,12 @@ +Exécution des tests +=================== + +.. note:: + La documentation va être revue ici. + +Les tests sont gérés par ``pytest`` dans le module ``squirrelbattle.tests``. + +``tox`` est un outil permettant de configurer l'exécution des tests. Ainsi, après +installation de tox dans votre environnement virtuel via ``pip install tox``, +il vous suffit d'exécuter ``tox -e py3`` pour lancer les tests et ``tox -e linters`` +pour vérifier la syntaxe du code.