Documentation

Le projet utilise Sphinx pour générer de la documentation à partir de docstrings (documentation en code) et de pages personnalisées écrites en Markdown (via MyST parser).

Générer le site web de documentation

Pour le générer :

# installer les dépendances supplémentaires
python3 -m pip install -e '.[doc]'
# le générer
sphinx-build -b html docs docs/_build/html
# optimisé (silencieux, multiprocessing, doctrees séparés)
sphinx-build -b html -d docs/_build/cache -j auto -q docs docs/_build/html

Ouvrez docs/_build/index.html dans un navigateur web.

Ecrire la documentation en utilisant live render

sphinx-autobuild -b html docs/ docs/_build

Ouvrez http://localhost:8000 dans un navigateur web pour voir le rendu HTML mis à jour lorsqu’un fichier est enregistré.

Déployer le site web de documentation

Le site de documentation est hébergé sur GitLab Pages pour chaque commit poussé sur la branche principale.

La documentation est accessible à l’url suivante : https://geoplateforme.pages.gpf-tech.ign.fr/altimetrie/api-rest-calcul-altimetrique/