From 3a425c6792c6bef0e8d1fa0253e2a1ce393c712e Mon Sep 17 00:00:00 2001 From: Bartuccio Antoine Date: Tue, 13 Aug 2019 00:02:34 +0200 Subject: [PATCH] documentation: add infos about fontawesome + tests instructions + more external doc --- doc/about/tech.rst | 19 +++++++++++++++++++ doc/index.rst | 21 +++++++++++++++++++++ doc/start/install.rst | 19 +++++++++++++++++++ 3 files changed, 59 insertions(+) diff --git a/doc/about/tech.rst b/doc/about/tech.rst index 76ea16e9..155f2792 100644 --- a/doc/about/tech.rst +++ b/doc/about/tech.rst @@ -25,6 +25,10 @@ Python 3 Le python est un langage de programmation interprété multi paradigme sorti en 1991. Il est très populaire pour sa simplicité d'utilisation, sa puissance, sa stabilité, sécurité ainsi que sa grande communauté de développeur. Sa version 3, non rétro compatible avec sa version 2, a été publiée en 2008. +.. note:: + + Puisque toutes les dépendances du backend sont des packages Python, elles sont toutes ajoutées directement dans le fichier **requirements.txt** à la racine du projet. + Django ~~~~~~ @@ -89,6 +93,21 @@ Sass (Syntactically Awesome Stylesheets) est un langage dynamique de génératio C'est une technologie stable, mature et pratique qui ne nécessite pas énormément d'apprentissage. +Fontawesome +~~~~~~~~~~~ + +`Site officiel `__ + +Fontawesome regroupe tout un ensemble d'icônes libres de droits utilisables facilement sur n'importe quelle page web. Ils sont simple à modifier puisque modifiables via le CSS et présentent l'avantage de fonctionner sur tous les navigateurs contrairement à un simple icône unicode qui s'affiche lui différemment selon la plate-forme. + +.. note:: + + C'est une dépendance capricieuse qu'il évolue très vite et qu'il faut très souvent mettre à jour. + +.. warning:: + + Il a été décidé de **ne pas utiliser** de CDN puisque le site ralentissait régulièrement. Il est préférable de fournir cette dépendance avec le site. + Documentation ------------- diff --git a/doc/index.rst b/doc/index.rst index c6200cc0..13eaf977 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -42,12 +42,33 @@ Bienvenue sur la documentation du Sith de l'AE Documentations complémentaires ------------------------------ +Python et Django +~~~~~~~~~~~~~~~~ + * `Apprendre Python `__ * `Documentation de Django `__ * `Classy Class-Based Views `__ + +HTML/Jinja/JS/(S)CSS +~~~~~~~~~~~~~~~~~~~~ + +* `Cours sur le javascript `__ +* `Cours sur jQuery `__ +* `Cours sur le HTML et CSS `__ +* `Documentation sur les grilles CSS `__ +* `Guide pour le SASS `__ +* `Documentation de fontawesome `__ +* `Documentation pour Jinja2 `__ + +Git +~~~ + * `Cours sur Git `__ * `Livre sur Git `__ + + + Documents téléchargeables ------------------------- diff --git a/doc/start/install.rst b/doc/start/install.rst index 7ea55c07..6f7ff2bc 100644 --- a/doc/start/install.rst +++ b/doc/start/install.rst @@ -84,3 +84,22 @@ Pour l'utiliser en local ou globalement pour la modifier, il existe une commande .. sourcecode:: bash ./manage.py documentation + +Lancer les tests +---------------- + +Pour lancer les tests il suffit d'utiliser la commande intégrée à django. + +.. code-block:: bash + + # Lancer tous les tests + ./manage.py test + + # Lancer les tests de l'application core + ./manage.py test core + + # Lancer les tests de la classe UserRegistrationTest de core + ./manage.py test core.tests.UserRegistrationTest + + # Lancer une méthode en particulier de cette même classe + ./manage.py test core.tests.UserRegistrationTest.test_register_user_form_ok