Comment modifier la documentation JSDoc - mathalea/mathalea GitHub Wiki
La documentation est générée à l'aide de jsdoc en utilisant le thème docdash.
Pour générer la documentation, il suffit de lancer pnpm run build:doc
dans un terminal.
Remarque :
Sous Windows, le
pnpm run build:doc
ne fonctionne pas actuellement. En attendant que ce soit réparé, vous pouvez build la doc en lançantC:\\Chemin\\Vers\\"mon dossier"\\mathalea\\node_modules\\.bin\\jsdoc -c C:\\Chemin\\Vers\\"mon dossier"\\mathalea\\jsdoc\\base.json
en remplaçant le\\Chemin\\Vers\\"mon dossier"\\mathalea
par le chemin vers votre dossier mathalea.
Et pour la visualiser, il suffit de lancer pnpm run doc:show
dans un terminal.
Vous pouvez faire les deux actions en une ligne en lançant pnpm run doc show
(sans les deux points).
Lorsqu'on lance pnpm run build:doc
, les fichiers base.json
, mathalea2d.json
, mathaleaInstrumEnPoche.json
et tout.json
du dossier jsdoc/
sont lus.
base.json
va générer une documentation dans le dossierdocumentation/
- dont la page d'accueil sera une version html de
src/demarrage.md
; - qui contiendra des versions html des .md de
jsdoc/tutorials/
; - qui recopiera le contenu de
jsdoc/static/
à la racine du dossierdocumentation/
; - qui créera des pages html à partir des commentaires trouvés dans les fichiers
src/js/modules/outils.js
,src/js/modules/fractions.js
,src/js/modules/Fraction.js
etsrc/js/modules/ListeFraction.js
encore une fois dans le dossierdocumentation
.
- dont la page d'accueil sera une version html de
mathalea2d.json
va générer une documentation dans le dossierdocumentation/2d/
à partir des commentaires du fichiersrc/js/modules/2d.js
et dont la page d'accueil sera créée à partir dejsdoc/2d.md
.mathaleaInstrumEnPoche.json
va générer une documentation dans le dossierdocumentation/instrumenpoche/
à partir des commentaires du fichiersrc/js/modules/Alea2iep.js
et dont la page d'accueil sera créée à partir dejsdoc/iep.md
.tout.json
va générer une documentation dans le dossierdocumentation/tout
à partir des commentaires de tous les fichiers du dossiersrc/js/
.
Lorsqu'on lance pnpm run doc:show
on atterrit sur la page d'accueil du base.json
qui contient en début de page des liens vers les trois autre documentations.