documentation: add doc compile test in pipeline

.gitlab-ci.yml

@@ -15,6 +15,8 @@ test:
   - coverage run ./manage.py test
   - coverage html
   - coverage report
+  - cd doc
+  - make html # Make documentation
   artifacts:
     paths:
       - coverage_report/

README.rst

@@ -2,6 +2,10 @@
   :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
   :alt: pipeline status
 
+.. image:: https://readthedocs.org/projects/sith-ae/badge/?version=latest
+  :target: https://sith-ae.readthedocs.io/?badge=latest
+  :alt: documentation Status
+
 .. image:: https://ae-dev.utbm.fr/ae/Sith/badges/master/coverage.svg
   :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
   :alt: coverage report
@@ -14,10 +18,6 @@
   :target: https://ae-dev.zulipchat.com
   :alt: project chat
 
-.. image:: https://readthedocs.org/projects/sith-ae/badge/?version=latest
-  :target: https://sith-ae.readthedocs.io/?badge=latest
-  :alt: documentation Status
-
 | **Website** is available here https://ae.utbm.fr/.
 | **Documentation** is available here https://sith-ae.readthedocs.io/.
 

doc/conf.py

@@ -16,10 +16,6 @@ import django
 
 sys.path.insert(0, os.path.abspath(".."))
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sith.settings")
-
-# from django.conf import settings
-
-# settings.configure()
 django.setup()
 
 

doc/misc/prod.rst

@@ -7,7 +7,7 @@ Configurer Sentry
 Pour connecter l'application à une instance de sentry (ex: https://sentry.io) il est nécessaire de configurer la variable **SENTRY_DSN** dans le fichier *settings_custom.py*. Cette variable est composée d'un lien complet vers votre projet sentry.
 
 Récupérer les statiques
----------------------
+-----------------------
 
 Nous utilisons du SCSS dans le projet. En environnement de développement (DEBUG=True), le SCSS est compilé à chaque fois que le fichier est demandé. Pour la production, le projet considère que chacun des fichier est déjà compilé, et, pour ce faire, il est nécessaire d'utiliser les commandes suivantes dans l'ordre :