SITUATION PROFESSIONNELLE 3
Docs as Code Sphinx & GitLab
Mise en place d'un pipeline de documentation "Docs as Code" avec Sphinx, reStructuredText et GitLab CI/CD pour générer automatiquement la documentation technique.
GitLab CI
Sphinx
Docker
reStructuredText
🎯 Objectif
Moderniser la gestion de la documentation technique de l'équipe.
- Remplacer les fichiers Word/PDF statiques par une documentation versionnée (Git).
- Générer un site statique HTML consultable via navigateur.
- Automatiser le déploiement à chaque commit avec GitLab CI.
⚙️ Architecture du Pipeline
1. Rédaction en reStructuredText (.rst)
2. Push sur GitLab Repo
3. Trigger GitLab CI/CD
4. Build Docker (Image Sphinx)
5. Génération HTML
6. Déploiement GitLab Pages
2. Push sur GitLab Repo
3. Trigger GitLab CI/CD
4. Build Docker (Image Sphinx)
5. Génération HTML
6. Déploiement GitLab Pages
Bilan Personnel
J'ai découvert la puissance de l'approche "Docs as Code". J'ai appris à écrire des pipelines CI/CD basiques et à utiliser Docker pour encapsuler l'environnement de build, rendant la documentation pérenne et facile à maintenir.
Captures Pipeline
Pipeline CI/CD
Documentation Sphinx
Site Généré