Documentation

Mélodium est capable de générer de la documentation pour tout programme Mélodium. La commande melodium doc extrait la documentation des éléments composant un programme, ainsi que leurs caractéristiques, et restitue l'ensemble sous forme de projet mdBook.

Génération de la documentation

La documentation d'un programme peut être générée avec la commande doc, où <fichier> est le projet à documenter (chemin vers le projet, fichier .mel, ou fichier .jeu), et <répertoire> l'emplacement où rédiger le mdBook :

$ melodium doc --file <fichier> 

Construction avec mdBook

Pour construire la documentation et obtenir une version HTML, PDF, ou autre, il est nécessaire d'utiliser mdBook.

Avec mdBook installé, il suffit d'entrer la commande suivante pour générer la documentation au format HTML, avec <répertoire> comme emplacement où Mélodium a rédigé le mdBook :

$ mdbook build --open <répertoire>