From c83b30f27b2434e33c6f7cb6195afb3d9fa96afc Mon Sep 17 00:00:00 2001 From: Bartuccio Antoine Date: Wed, 14 Aug 2019 18:56:53 +0200 Subject: [PATCH] documentation: add doc compile test in pipeline --- .gitlab-ci.yml | 2 ++ README.rst | 8 ++++---- doc/conf.py | 4 ---- doc/misc/prod.rst | 2 +- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5c6a6ed2..bc2bcea5 100644 --- a/.gitlab-ci.yml +++ b/.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/ diff --git a/README.rst b/README.rst index ad996ba1..b315a70e 100644 --- a/README.rst +++ b/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/. diff --git a/doc/conf.py b/doc/conf.py index cabd82db..673f4477 100644 --- a/doc/conf.py +++ b/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() diff --git a/doc/misc/prod.rst b/doc/misc/prod.rst index b628c28f..959a16af 100644 --- a/doc/misc/prod.rst +++ b/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 :