klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2024-11-26 02:54:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: add doc compile test in pipeline

Browse Source
This commit is contained in:
Antoine Bartuccio 2019-08-14 18:56:53 +02:00
parent db10f7b963
commit c83b30f27b
Signed by: klmp200
GPG Key ID: E7245548C53F904B
4 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitlab-ci.yml
View File

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

8
README.rst
View File

@ -2,6 +2,10 @@
:target: https://ae-dev.utbm.fr/ae/Sith/commits/master :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
:alt: pipeline status :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 .. image:: https://ae-dev.utbm.fr/ae/Sith/badges/master/coverage.svg
:target: https://ae-dev.utbm.fr/ae/Sith/commits/master :target: https://ae-dev.utbm.fr/ae/Sith/commits/master
:alt: coverage report :alt: coverage report
@ -14,10 +18,6 @@
:target: https://ae-dev.zulipchat.com :target: https://ae-dev.zulipchat.com
:alt: project chat :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/. | **Website** is available here https://ae.utbm.fr/.
| **Documentation** is available here https://sith-ae.readthedocs.io/. | **Documentation** is available here https://sith-ae.readthedocs.io/.

4
doc/conf.py
View File

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

2
doc/misc/prod.rst
View File

@ -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. 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 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 : 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 :