diff --git a/docs/pages/html/_images/imggui01.png b/docs/pages/html/_images/imggui01.png new file mode 100644 index 0000000..e0362d4 Binary files /dev/null and b/docs/pages/html/_images/imggui01.png differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bold.eot b/docs/pages/html/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 0000000..3361183 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bold.ttf b/docs/pages/html/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 0000000..29f691d Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bold.woff b/docs/pages/html/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bold.woff2 b/docs/pages/html/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bolditalic.eot b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 0000000..3d41549 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bolditalic.ttf b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 0000000..f402040 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-italic.eot b/docs/pages/html/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 0000000..3f82642 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-italic.ttf b/docs/pages/html/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 0000000..b4bfc9b Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-italic.woff b/docs/pages/html/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-italic.woff2 b/docs/pages/html/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-regular.eot b/docs/pages/html/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 0000000..11e3f2a Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-regular.ttf b/docs/pages/html/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 0000000..74decd9 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-regular.woff b/docs/pages/html/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/pages/html/_static/fonts/Lato/lato-regular.woff2 b/docs/pages/html/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/pages/html/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 0000000..79dc8ef Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 0000000..df5d1df Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 0000000..2f7ca78 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 0000000..eb52a79 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/pages/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/pages/html/_static/js/versions.js b/docs/pages/html/_static/js/versions.js new file mode 100644 index 0000000..4958195 --- /dev/null +++ b/docs/pages/html/_static/js/versions.js @@ -0,0 +1,228 @@ +const themeFlyoutDisplay = "hidden"; +const themeVersionSelector = true; +const themeLanguageSelector = true; + +if (themeFlyoutDisplay === "attached") { + function renderLanguages(config) { + if (!config.projects.translations.length) { + return ""; + } + + // Insert the current language to the options on the selector + let languages = config.projects.translations.concat(config.projects.current); + languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
+
Languages
+ ${languages + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file