Documentation

Bonjour,

Français

La documentation de « Ada for Automation » est incluse dans les sources du projet, dans le répertoire « book » notamment, mais également dans les divers fichiers README.

Ce sont de simples fichiers textes au format Asciidoc.

On peut convertir ce format en HTML ou PDF entre autres avec Asciidoctor par exemple.

Cette documentation contient des diagrammes PlantUML ainsi que des portions de code source liées.

Afin que l’ensemble reste cohérent, on utilise la fonctionnalité d’intégration continue / déploiement continu proposé par GitLab CI/CD et le résultat est déployé dans GitLab Pages.

Ce résultat est disponible depuis le portail.

Cordialement,
Stéphane

English

The « Ada for Automation » documentation is included in project sources, in the « book » folder in particular, but also in the various README files.

Those are simple plain text files in format Asciidoc.

This format can be converted to HTML or PDF among others using Asciidoctor for example.

The documentation contains PlantUML diagrams and also portions of linked source code.

To get a consistent ensemble, we use the continuous integration / continuous deployment functionality offered by GitLab CI/CD and the result is deployed in GitLab Pages.

This result is available from the portal.

Best Regards,
Stéphane

Laisser un commentaire