klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2024-11-22 14:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: add help ressources and update installation instructions

Browse Source
This commit is contained in:
Antoine Bartuccio 2019-10-13 02:15:58 +02:00
parent bfa4000365
commit 77dddbc581
Signed by: klmp200
GPG Key ID: E7245548C53F904B
3 changed files with 42 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -25,7 +25,7 @@ All documentation is in the ``docs`` directory and online at https://sith-ae.rea
If you want to contribute, here's how we recommend to read the docs: If you want to contribute, here's how we recommend to read the docs:
* First, it's advised to read the about part of the project to understand the goals and the mindset of the current and previous maintainers and know what to expect to learn. * First, it's advised to read the about part of the project to understand the goals and the mindset of the current and previous maintainers and know what to expect to learn.
* If in the first part you find you need more background about what we use, we provide some links to tutorials and documentation at the end of our documentation. Feel free to use it and complete it with what you found helpful. * If in the first part you realize that you need more background about what we use, we provide some links to tutorials and documentation at the end of our documentation. Feel free to use it and complete it with what you found helpful.
* Keep in mind that this documentation is thought to be read in order. * Keep in mind that this documentation is thought to be read in order.
To join our team : To join our team :

1
doc/index.rst
View File

@ -63,6 +63,7 @@ Python et Django
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
* `Apprendre Python <https://openclassrooms.com/fr/courses/235344-apprenez-a-programmer-en-python>`__ * `Apprendre Python <https://openclassrooms.com/fr/courses/235344-apprenez-a-programmer-en-python>`__
* `Apprendre Django <https://openclassrooms.com/fr/courses/1871271-developpez-votre-site-web-avec-le-framework-django>`__
* `Documentation de Django <https://docs.djangoproject.com/fr/1.11/>`__ * `Documentation de Django <https://docs.djangoproject.com/fr/1.11/>`__
* `Classy Class-Based Views <http://ccbv.co.uk/projects/Django/1.11/>`__ * `Classy Class-Based Views <http://ccbv.co.uk/projects/Django/1.11/>`__

27
doc/start/install.rst
View File

@ -7,12 +7,14 @@ Dépendances du système
Certaines dépendances sont nécessaires niveau système : Certaines dépendances sont nécessaires niveau système :
* virtualenv * virtualenv
* limysqlclient * libmysqlclient
* libssl * libssl
* libjpeg * libjpeg
* python3-xapian * python3-xapian
* zlib1g-dev * zlib1g-dev
* python3 * python3
* gettext
* graphviz
* mysql-client (pour migrer de l'ancien site) * mysql-client (pour migrer de l'ancien site)
Sur Ubuntu Sur Ubuntu
@ -30,8 +32,21 @@ Pour installer les dépendances, il est fortement recommandé d'installer le ges
.. sourcecode:: bash .. sourcecode:: bash
brew install git python xapian brew install git python xapian graphviz
pip install virtualenv
# Si vous aviez une version de python ne venant pas de homebrew
brew link --overwrite python
# Pour bien configurer gettext
brew link gettext # (suivez bien les instructions supplémentaires affichées)
# Pour installer virtualenv
pip3 install virtualenv
.. note::
Si vous rencontrez des erreurs lors de votre configuration, n'hésitez pas à vérifier l'état de votre installation homebrew avec :code:`brew doctor`
Installer le projet Installer le projet
------------------- -------------------
@ -48,9 +63,15 @@ Installer le projet
# Installe les dépendances du projet # Installe les dépendances du projet
pip install -r requirements.txt pip install -r requirements.txt
# Si vous avez des problèmes avec graphiviz
pip install pygraphviz --install-option="--include-path=/usr/include/graphviz" --install-option="--library-path=/usr/lib/graphviz/"
# Prépare la base de donnée # Prépare la base de donnée
./manage.py setup ./manage.py setup
# Installe les traductions
./manage compilemessages
.. note:: .. note::
Pour éviter d'avoir à utiliser la commande source sur le virtualenv systématiquement, il est possible de consulter :ref:`direnv`. Pour éviter d'avoir à utiliser la commande source sur le virtualenv systématiquement, il est possible de consulter :ref:`direnv`.