Produire la documentation HTML grâce à l’intégration continue de gitlab

Le fichier gitlab-ci.yml

 1---
 2# .gitlab-ci.yml
 3# ===============
 4#
 5#
 6image: cicirello/pyaction:latest
 7
 8
 9pages:
10  stage: deploy
11  script:
12  - pip install -U pip
13  - pip install -r requirements.txt
14  # http://www.sphinx-doc.org/en/master/usage/quickstart.html
15  - sphinx-build -d _build/doctrees . _build/html
16  - mv _build/html public
17  artifacts:
18    paths:
19    - public
20  only:
21  - main

Sélection du runner “documentation”

Pour produire la documentation, il faut un “runner” gitlab qui doit être sélectionné dans la page gitlab “settings/ci_cd” (https://gitlab.srv.int.id3.eu/Informatique/intranet/demo-sphinx/-/settings/ci_cd)

../_images/runner_documentation.png

URL de la documentation produite (https://informatique.gitlab.srv.int.id3.eu/intranet/demo-sphinx)

L’information donnant l’URL de la documentation produite se trouve dans la page gitlab “pages” (https://gitlab.srv.int.id3.eu/Informatique/intranet/demo-sphinx/pages)

../_images/access_pages.png

Fig. 2 https://informatique.gitlab.srv.int.id3.eu/intranet/demo-sphinx

Bonne pratique gitlab : placer l’URL dans la description du projet gitlab

Une fois connue l’URL de la documentation, on peut placer cette URL dans la description du projet gitlab (https://gitlab.srv.int.id3.eu/Informatique/intranet/demo-sphinx/edit).

../_images/url_doc_dans_description_du_projet_gitlab.png
../_images/projet_avec_url.png

Fig. 3 https://gitlab.srv.int.id3.eu/Informatique/intranet/demo-sphinx