documentation: remove Doxygen, include README into doc update tech and install

This commit is contained in:
2019-08-11 14:11:00 +02:00
parent dd49d71cb7
commit 8dcade6890
6 changed files with 116 additions and 2427 deletions

View File

@ -133,6 +133,14 @@ GitLab est une alternative libre à GitHub. C'est une plate-forme avec interface
C'est au travers de cette plate-forme que le Sith de l'AE est géré, sur une instance hébergée directement sur nos serveurs.
Sentry
~~~~~~
| `Site officiel <https://sentry.io>`__
| `Instance de l'AE <https://ae2.utbm.fr`__
Sentry est une plate-forme libre qui permet de se tenir informer des bugs qui ont lieu sur le site. À chaque crash du logiciel (erreur 500), une erreur est envoyée sur la plate-forme et est indiqué précisément à quelle ligne de code celle-ci a eu lieu, à quelle heure, combien de fois, avec quel navigateur la page a été visitée et même éventuellement un commentaire de l'utilisateur qui a rencontré le bug.
Virtualenv
~~~~~~~~~~

View File

@ -6,6 +6,9 @@
Bienvenue sur la documentation du Sith de l'AE
==============================================
.. include:: ../README.rst
:end-before: body
.. toctree::
:maxdepth: 2
:caption: À propos du projet:
@ -23,4 +26,7 @@ Bienvenue sur la documentation du Sith de l'AE
:maxdepth: 3
:caption: Documentation des apps:
apps/core
apps/core
.. include:: ../README.rst
:start-after: body

View File

@ -13,15 +13,18 @@ Certaines dépendances sont nécessaires niveau système :
* python3-xapian
* zlib1g-dev
* python3
* mysql-client (pour migrer de l'ancien site)
Sur ubuntu :
Sur Ubuntu
~~~~~~~~~~
.. sourcecode:: bash
sudo apt install libmysqlclient-dev libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config python3-xapian gettext git
sudo pip3 install virtualenv
Sur macos :
Sur MacOS
~~~~~~~~~
Pour installer les dépendances, il est fortement recommandé d'installer le gestionnaire de paquets `homebrew <https://brew.sh/index_fr>`__.
@ -65,4 +68,17 @@ Il faut toujours avoir préalablement activé l'environnement virtuel comme fait
.. sourcecode:: bash
./manage.py runserver
./manage.py runserver
Le serveur est alors accessible à l'adresse `http://localhost:8000 <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>`__.
.. sourcecode:: bash
./manage.py documentation