La documentation de l'inventaire national des orgues

Le site de documentation pour l'inventaire des orgues.

Comment mettre à jour cette documentation ?

Le fichiers .org ont pour ce faire été convertis en fichiers Markdown .md façon Github Flavored Markdown style gfm, à l'aide de l'outil Pandoc.

./pandoc --from org --to gfm -o ido-docs/donnees.md ido-docs/donnees.org

Une documentation sur Markdown.

La documentation est générée depuis Markdown en HTML à l'aide de l'utilitaire Python de génération de sites statiques Mkdocs

Pour générer le site de documentation avec Mkdocs et éventuellement lancer le serveur local :

• installer le module mkdocs avec pip
• générer la documentation
  • soit depuis une console, via la ligne de commande mkdocs build
  • soit directement depuis Python via un script de lancement generate.py adapté depuis un exemple trouvé sur le web
• en phase de développement, lancer le serveur local via la ligne de commande mkdocs serve

Le fichier de configuration, en langage yaml, peut-être personnalisé, notamment si l'on souhaite changer le thème.

Pour mémoire : anciennes pages de documentation

Initialement, ce site avait été mis en place par Bastien Guerry à l'aide de :

• module Org mode pour l'éditeur EMACS;
• modèle ReadTheOrg, construit à partir du thème ReadTheDocs.