Fonctionnement

La configuration du menu se fait dans le fichier doc.yaml dans l'item nav.

Toutes les pages sont dans le dossier src et la hiérarchie des dossiers doit correspondre à l'architecture de la configuration nav afin que le script python puisse reconstruire les fichiers html.

Installation

La documentation est génée grâce à un script python

• Installer python3
• Installer les libraire requis au projet depuis le répertoire builder avec la commande pip install -r requirements.txt
• Lancer la commande python3 build.py depuis le répertoire builder
• Les pages html sont ensuite générées dans le répertoire page

Ajouter une nouvelle page

Pour ajouter une nouvelle page:

• Créer un nouveau dossier dans src correspondant à la "catégorie"
• Dans ce dossier créer un sous-dossier correspondant à la "page"
• Ce dossier doit contenir un fichier index.html qui contiendera le contenu de la doc
• Tous les fichiers .js et .css dans le dossier seront automatiquement chargés pour cette page

Integrer des images

Pour intégrer une image dans un document:

• Ajouter le fichier image dans le même dossier que le fichier index.html de votre page
• Ajouter une balise <img src="../src/introduction/documentation//fichier_image.jpg"/>

Intégrer des diagrammes (draw.io)

Pour inserer un diagramme dans un document:

• Créer un diagramme draw.io et l'enregistrer dans le projet au format xml (pas sur le drive)
• Cliquer sur Fichier > intégrer > HTML Bien vérifier que la case "Inclure une copie de mon diagramme est cochée"
• Copier / coller ensuite le HTML dans une page du document

Intégrer des shéma (EasyEDA)

Pour inserer un shéma dessiné avec EasyEDA avec apercu dans une modale:

• Dans EasyEDA, cliquer sur Fichiers > Exporter > SVG (tout laisser par défaut)
• Exporter le dans le même dossier que le fichier index.html de votre page
• Ajouter la variable [[fichier_schema.svg]] dans la page

Intégrer des SVG

Pour inserer un SVG (avec apercu dans une modale):

• Ajouter un fichier .svg dans le même dossier que le fichier index.html de votre page
• Ajouter la variable [[fichier_svg.svg]] dans la page