klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2025-07-10 03:49:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: update instructions, add down loadable files and add all pdf reports for download purpose

Browse Source
This commit is contained in:
Antoine Bartuccio
2019-08-11 23:10:09 +02:00
parent 8dcade6890
commit 782a763046
8 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/start/install.rst
View File

@ -26,7 +26,7 @@ Sur Ubuntu
Sur MacOS
~~~~~~~~~
Pour installer les dépendances, il est fortement recommandé d'installer le gestionnaire de paquets `homebrew <https://brew.sh/index_fr>`__.
Pour installer les dépendances, il est fortement recommandé d'installer le gestionnaire de paquets `homebrew <https://brew.sh/index_fr>`_.
.. sourcecode:: bash
@ -70,15 +70,17 @@ Il faut toujours avoir préalablement activé l'environnement virtuel comme fait
./manage.py runserver
Le serveur est alors accessible à l'adresse `http://localhost:8000 <http://localhost:8000`__.
.. note::
Le serveur est alors accessible à l'adresse http://localhost:8000.
Générer la documentation
------------------------
La documentation est automatiquement mise en ligne sur readthedocs à chaque envoi de code sur GitLab.
Pour l'utiliser en local ou globalement pour la modifier, il existe une commande du site qui génère la documentation et lance un serveur la rendant accessible à l'adresse `http://localhost:8080 <http://localhost:8080>`__.
Pour l'utiliser en local ou globalement pour la modifier, il existe une commande du site qui génère la documentation et lance un serveur la rendant accessible à l'adresse http://localhost:8080.
.. sourcecode:: bash
./manage.py documentation
./manage.py documentation