Skip to content

Commit 86067d6

Browse files
CI: Documentation (#21)
- Ajout du dossier .github et workflows - Ajout du fichier documentation.yaml qui contient l'action pour générer la documentation - Ajout de l'action sur chaque push vers la branche develop
1 parent b11265d commit 86067d6

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Construction et déploiement de la configuration
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write # Nécessaire pour déployer sur GitHub Pages
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Positionnement sur le dépôt
19+
uses: actions/checkout@v4
20+
21+
- name: Mis en place de Python
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: '3.x'
25+
26+
- name: Installation des dépendances
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install sphinx
30+
pip install sphinx_rtd_theme --break-system-packages
31+
32+
- name: Construction de la documentation (avec Sphinx)
33+
run: |
34+
sphinx-build -b html docs/source docs/build/html
35+
36+
- name: Publication la documentation générée
37+
uses: actions/upload-pages-artifact@v3
38+
with:
39+
path: docs/build/html # Dossier contenant la doc générée
40+
41+
deploy:
42+
needs: build
43+
runs-on: ubuntu-latest
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)