Documentation

Génération des pages de la documentation sur Github

La documentation est générée grâce à une action Github définie dans le fichier .github/workflows/build-docs.yml se situant à la racine du projet.

Pour lancer cette génération :

• Cliquer sur Releases pour se rendre sur la gestion de releases

  

• Cliquer sur Draft a new release pour accéder à la page de création d'une nouvelle release

  

• Créer un nouveau tag au format doc-x.x.x qui permettra à l'action de génération de la documentation de se lancer

  

• Sélectionner la branche à partir de laquelle créer le tag, mettre un titre de la forme Documentation - Version x.x.x, et cocher la case Set as a pre-release

  

• Aller sur l'onglet Actions pour suivre le processus l'action Build documentation qui s'est lancée

  

• Cliquer sur l'action pour suivre les différentes étapes du processus et s'assurer que toutes les coches sont au vert à la fin du processus

  

La nouvelle version de la documentation est disponible ici : https://doc.roboteek.fr/