Maarch Courrier Documentation 21.03
Documentation de Maarch Courrier écrite en Markdown, convertie en HTML avec mkdocs-material.
Pré-requis
- python3
- pip
- weasyprint (pour la conversion PDF)
- git
Installer les dépendances python :
python3 -m pip install mkdocs mkdocs-material mkdocs-with-pdf mkdocs-git-revision-date-localized-plugin
Construire la documentation en local
python3 -m mkdocs build --strict
Construire la documentation en mode développement
python3 -m mkdocs serve
La documentation sera disponible à l'adresse http://localhost:8000.
La documentation sera automatiquement rafraichi à chaque modification des pages .md.
Build avec la version PDF
Le build de la documentation en PDF est assez long, donc ce build est activé uniquement dans la génération en CI.
Pour obtenir le PDF en local, il faut mettre la variable d'environnement ENABLE_PDF_EXPORT à 1 :
export ENABLE_PDF_EXPORT=1
python3 -m mkdocs build --strict
Mode Docker
Génération de l'image de dévopopement :
docker build -t local/courrier-doc .
Lancer l'environnement de développement :
docker compose -f compose.yml up -d
Acccès à l'interface de la documentation :
Le container est lié à votre projet local, les modifications effectuées seront prises en compte depuis cette adresse
Il est fortement conseillé de faire l'astuce du "Build plus rapide en local" pour avoir les modifications en temps réel