ynerant/squirrel-battle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

Prepare not-documented pages

Browse Source
This commit is contained in:
Yohann D'ANELLO 2020-11-19 22:32:25 +01:00
parent 6b2e420efe
commit 722dabb6e8
8 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/display/index.rst Normal file
View File

@ -0,0 +1,14 @@
Gestion de l'affichage
======================
Pas encore documenté.
.. toctree::
:maxdepth: 3
:caption: Affichage
menu
map
stats
logs

4
docs/display/logs.rst Normal file
View File

@ -0,0 +1,4 @@
Affichage de l'historique
=========================
Pas encore documenté.

4
docs/display/map.rst Normal file
View File

@ -0,0 +1,4 @@
Affichage de la carte
=====================
Pas encore documenté.

4
docs/display/menu.rst Normal file
View File

@ -0,0 +1,4 @@
Affichage des menus
===================
Pas encore documenté.

4
docs/display/stats.rst Normal file
View File

@ -0,0 +1,4 @@
Affichage des statistiques
==========================
Pas encore documenté.

3
docs/index.rst
View File

@ -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

4
docs/settings.rst Normal file
View File

@ -0,0 +1,4 @@
Paramètres
==========
Pas encore documenté.

12
docs/tests.rst Normal file
View File

@ -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.