Skip to content
Snippets Groups Projects
Commit 784cfbb1 authored by François Grand's avatar François Grand
Browse files

refactor(chore): move stylesheet files used by HTML documentation to a single directory

refs #612
parent c3b218a5
No related branches found
No related tags found
2 merge requests!225Release v4.17.0,!215Resolve "Documentation: localiser les dépendances javascript dans un seul dossier"
......@@ -11,8 +11,6 @@ const destPath_FR_JS = "src/assets/docs/fr/javascripts"; // pour la compilation
const destPath_EN_JS = "src/assets/docs/en/javascripts"; // pour la compilation en local (anglais)
const destPath_CSS = "src/assets/docs/stylesheets";
const destPath_FR_CSS = "src/assets/docs/fr/stylesheets"; // pour la compilation en local (français)
const destPath_EN_CSS = "src/assets/docs/en/stylesheets"; // pour la compilation en local (anglais)
const destPath_JS_MJ = destPath_JS + "/mathjax";
const destPath_FR_JS_MJ = destPath_FR_JS + "/mathjax"; // pour la compilation en local (français)
......@@ -38,8 +36,6 @@ fs.copySync("docs/mathjax.config.js", destPath_FR_JS + "/mathjax.config.js");
fs.copySync("docs/mathjax.config.js", destPath_EN_JS + "/mathjax.config.js");
fs.copySync("docs/mathjax-scrollbar.css", destPath_CSS + "/mathjax-scrollbar.css");
fs.copySync("docs/mathjax-scrollbar.css", destPath_FR_CSS + "/mathjax-scrollbar.css");
fs.copySync("docs/mathjax-scrollbar.css", destPath_EN_CSS + "/mathjax-scrollbar.css");
fs.copySync("docs/matomo-tracking.js", destPath_JS + "/matomo-tracking.js");
fs.copySync("docs/matomo-tracking.js", destPath_FR_JS + "/matomo-tracking.js");
......@@ -48,3 +44,56 @@ fs.copySync("docs/matomo-tracking.js", destPath_EN_JS + "/matomo-tracking.js");
fs.copySync("node_modules/mermaid/dist/mermaid.min.js", destPath_JS + "/mermaid.min.js");
fs.copySync("node_modules/mermaid/dist/mermaid.min.js", destPath_FR_JS + "/mermaid.min.js");
fs.copySync("node_modules/mermaid/dist/mermaid.min.js", destPath_EN_JS + "/mermaid.min.js");
/*
Ici, on veut que les ressources copiées ci dessus soit accessibles.
mkdocs-xx.yml :
extra_css:
- ../stylesheets/mathjax-scrollbar.css
Fichiers HTML générés :
Par ex src/assets/docs/fr/calculators/maths/solver.html contient <link rel="stylesheet" href="../../stylesheets/mathjax-scrollbar.css">
ce qui fait référence à stylesheets dans src/assets/docs/fr alors qu'on veut référencer stylesheets dans src/assets/docs/
(le chemin généré dépend de l'emplacement du fichier le contenant).
Le problème, c'est que si on modifie extra_css avec ../../stylesheets/mathjax-scrollbar.css, cela génère la même chose
(href="../../stylesheets/mathjax-scrollbar.css") vraisemblablement à cause de site_dir (=docs/fr) qui limite les "remontées"
de niveau de répertoire.
La solution est donc de modifier les fichiers HTML générés pour ajouter ../ dans href="...".
*/
const cp = require('child_process');
function execBashCmd(cmd) {
// console.log(cmd);
// console.log(cp.execSync(cmd, { encoding: 'utf-8' }));
cp.execSync(cmd);
}
function escapeSlash(s) {
return s.replaceAll('/', '\\\/');
}
function escapeDot(s) {
return s.replaceAll('\.', '\\.');
}
function escapeDoubleQuote(s) {
return s.replaceAll('"', '\\"');
}
function applyEscapes(s) {
return escapeDot(escapeSlash(escapeDoubleQuote(s)));
}
function replaceHtml(base_dir, s1, s2) {
s1 = applyEscapes(s1);
s2 = applyEscapes(s2);
const cmd = "find " + base_dir + " -name '*.html' -exec sed -i \"s/" + s1 + "/" + s2 + "/g\" {} \\\;";
execBashCmd(cmd);
}
replaceHtml("src/assets/docs/fr/", "../../stylesheets/mathjax-scrollbar.css", "../../../stylesheets/mathjax-scrollbar.css");
replaceHtml("src/assets/docs/en/", "../../stylesheets/mathjax-scrollbar.css", "../../../stylesheets/mathjax-scrollbar.css");
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