Génération de documentation
Définition
Lors de la livraison d'une nouvelle version du module, le but est de fournir à l'utilisateur final, une documentation d'installation/configuration & une documentation d'usage. Cette documentation ne serait pas dans le module mais bien à télécharger sur le store lors de l'achat.
Lors du CI & au moment du build, j'ai pensé à générer 2 documents PDF à partir des fichiers README.MD & DOCUMENTATION.MD .
Peux être un script Pyhton ?
Répartition des tâches
-
Définition des documents sources au sein de l'architecture (README.MD pour & DOCUMENTATION.MD pour doc. utilisateur ?) -
vérification sur l'ensemble des dépôts ce qui doit être adapté (en priorité les modules fournis sur le DOLISTORE & SUITE SERVICES).
-
Recherche sur l'outil de conversion MD -> PDF, -
POC.
-
Mise en place au sein du CI (étape à part entière ?) -
Vérification de l'existence de la documentation (USER_DOC - DOCUMENTATION - README) - création des fichiers si il n'existe pas via la CI
Modification effectuée par Clément Code 42