Skip to content
Snippets Groups Projects
Commit c2ad74d3 authored by mathias.chouet's avatar mathias.chouet
Browse files

Refactor mkdocs source / destination directories #355

parent 11700ae1
No related branches found
No related tags found
1 merge request!73Resolve "Documentation : copier mathjax une seule fois pour l'ensemble des langues"
Showing
with 6 additions and 21 deletions
......@@ -4,16 +4,14 @@
/dist
/tmp
/out-tsc
/src/assets/docs-*
/src/assets/docs
/compodoc-fr
/docs-fr_pdf
/docs-en_pdf
/docs/fr/pdf
/docs/en/pdf
/release
# dependencies
/node_modules
/docs-fr/javascripts/mathjax
/docs-en/javascripts/mathjax
/src/date_revision.ts
# IDEs and editors
......
......@@ -114,7 +114,7 @@ Le déploiement de ngHyd sous forme d'application mobile se fait à l'aide de Co
La documentation est générée à l'aide de MkDocs.
Les fichiers source pour une langue donnée se trouvent dans le dossier `docs-lang` (ex: `docs-fr`). Pour traduire la documentation dans une autre langue, il faut recopier l'intégralité des fichiers source puis les traduire. Afin de faciliter les liens de l'application vers la documentation, les noms des fichiers ne sont pas traduits et restent en français pour toutes les langues.
Les fichiers source pour une langue donnée se trouvent dans le dossier `docs/lang` (ex: `docs/fr`). Pour traduire la documentation dans une autre langue, il faut recopier l'intégralité des fichiers source puis les traduire. Afin de faciliter les liens de l'application vers la documentation, les noms des fichiers ne sont pas traduits et restent en français pour toutes les langues.
L'organisation hiérarchique de la documentation est définie dans les fichiers `mkdocs-lang.yml` (ex: `mkdocs-fr.yml`).
......@@ -392,7 +392,7 @@ Dans la fonction `parseConfig()`, ajouter un appel par à `setPropertyValueFromC
### documentation
Pour chaque langue, ajouter un fichier .md dans les dossiers `docs-*/calculators`, puis placer ce nouveau fichier dans la hiérarchie de la documentation, en ajoutant son chemin dans les fichiers `mkdocs-*.yml`.
Pour chaque langue, ajouter un fichier .md dans les dossiers `docs/*/calculators`, puis placer ce nouveau fichier dans la hiérarchie de la documentation, en ajoutant son chemin dans les fichiers `mkdocs-*.yml`.
Lier ce fichier au module via la clé `help` du bloc d'options de la configuration du module. Exemple pour un fichier de documentation dont le chemin est `calculators/math/addition.md` : `"help" : "math/addition.html"` (MkDocs convertit les fichiers MarkDown en HTML)
......
../CHANGELOG.md
\ No newline at end of file
../CHANGELOG.md
\ No newline at end of file
var _paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['disableCookies']); // évite de mettre en place un bandeau RGPD
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//stasi.g-eau.fr/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '1']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
\ No newline at end of file
../../CHANGELOG.md
\ No newline at end of file
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment