summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo van Kemenade <1324225+hugovk@users.noreply.github.com>2024-05-27 18:49:52 (GMT)
committerGitHub <noreply@github.com>2024-05-27 18:49:52 (GMT)
commit0a4a3184f56a1e4e8cb4d3466cee20388bf7f00d (patch)
tree91f470daac932b8f5fe0313800f7f5fe5aeec4eb
parent8117cb5f01c9519f9f1a9fd92af32a804f197603 (diff)
downloadcpython-0a4a3184f56a1e4e8cb4d3466cee20388bf7f00d.zip
cpython-0a4a3184f56a1e4e8cb4d3466cee20388bf7f00d.tar.gz
cpython-0a4a3184f56a1e4e8cb4d3466cee20388bf7f00d.tar.bz2
[3.13] Docs: Move inline JavaScript to own file to reduce duplication (GH-119541) (#119630)
-rw-r--r--Doc/tools/static/rtd_switcher.js88
-rw-r--r--Doc/tools/templates/layout.html87
2 files changed, 90 insertions, 85 deletions
diff --git a/Doc/tools/static/rtd_switcher.js b/Doc/tools/static/rtd_switcher.js
new file mode 100644
index 0000000..a67bb85
--- /dev/null
+++ b/Doc/tools/static/rtd_switcher.js
@@ -0,0 +1,88 @@
+ function onSwitch(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()
+
+ // Add some mocked hardcoded versions pointing to the official
+ // documentation while migrating to Read the Docs.
+ // These are only for testing purposes.
+ // TODO: remove them when managing all the versions on Read the Docs,
+ // since all the "active, built and not hidden" versions will be shown automatically.
+ let versions = config.versions.active.concat([
+ {
+ slug: "dev (3.14)",
+ urls: {
+ documentation: "https://docs.python.org/3.14/",
+ }
+ },
+ {
+ slug: "dev (3.13)",
+ urls: {
+ documentation: "https://docs.python.org/3.13/",
+ }
+ },
+ {
+ slug: "3.12",
+ urls: {
+ documentation: "https://docs.python.org/3.12/",
+ }
+ },
+ {
+ slug: "3.11",
+ urls: {
+ documentation: "https://docs.python.org/3.11/",
+ }
+ },
+ ]);
+
+ const versionSelect = `
+ <select id="version_select">
+ ${ versions.map(
+ (version) => `
+ <option
+ value="${ version.slug }"
+ ${ config.versions.current.slug === version.slug ? 'selected="selected"' : '' }
+ data-url="${ version.urls.documentation }">
+ ${ version.slug }
+ </option>`
+ ).join("\n") }
+ </select>
+ `;
+
+ // Prepend 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 = `
+ <select id="language_select">
+ ${ languages.map(
+ (translation) => `
+ <option
+ value="${ translation.slug }"
+ ${ config.projects.current.slug === translation.slug ? 'selected="selected"' : '' }
+ data-url="${ translation.urls.documentation }">
+ ${ translation.language.name }
+ </option>`
+ ).join("\n") }
+ </select>
+ `;
+
+ // Query all the placeholders because there are different ones for Desktop/Mobile
+ const versionPlaceholders = document.querySelectorAll(".version_switcher_placeholder");
+ for (placeholder of versionPlaceholders) {
+ placeholder.innerHTML = versionSelect;
+ let selectElement = placeholder.querySelector("select");
+ selectElement.addEventListener("change", onSwitch);
+ }
+
+ const languagePlaceholders = document.querySelectorAll(".language_switcher_placeholder");
+ for (placeholder of languagePlaceholders) {
+ placeholder.innerHTML = languageSelect;
+ let selectElement = placeholder.querySelector("select");
+ selectElement.addEventListener("change", onSwitch);
+ }
+ });
diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html
index e931147..3f88fc8 100644
--- a/Doc/tools/templates/layout.html
+++ b/Doc/tools/templates/layout.html
@@ -43,90 +43,7 @@
{{ super() }}
{%- if not embedded %}
-<meta name="readthedocs-addons-api-version" content="1">
-<script type="text/javascript">
- function onSwitch(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()
-
- // Add some mocked hardcoded versions pointing to the official
- // documentation while migrating to Read the Docs.
- // These are only for testing purposes.
- // TODO: remove them when managing all the versions on Read the Docs,
- // since all the "active, built and not hidden" versions will be shown automatically.
- let versions = config.versions.active.concat([
- {
- slug: "dev (3.13)",
- urls: {
- documentation: "https://docs.python.org/3.13/",
- }
- },
- {
- slug: "3.12",
- urls: {
- documentation: "https://docs.python.org/3.12/",
- }
- },
- {
- slug: "3.11",
- urls: {
- documentation: "https://docs.python.org/3.11/",
- }
- },
- ]);
-
- const versionSelect = `
- <select id="version_select">
- ${ versions.map(
- (version) => `
- <option
- value="${ version.slug }"
- ${ config.versions.current.slug === version.slug ? 'selected="selected"' : '' }
- data-url="${ version.urls.documentation }">
- ${ version.slug }
- </option>`
- ).join("\n") }
- </select>
- `;
-
- // Prepend 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 = `
- <select id="language_select">
- ${ languages.map(
- (translation) => `
- <option
- value="${ translation.slug }"
- ${ config.projects.current.slug === translation.slug ? 'selected="selected"' : '' }
- data-url="${ translation.urls.documentation }">
- ${ translation.language.name }
- </option>`
- ).join("\n") }
- </select>
- `;
-
- // Query all the placeholders because there are different ones for Desktop/Mobile
- const versionPlaceholders = document.querySelectorAll(".version_switcher_placeholder");
- for (placeholder of versionPlaceholders) {
- placeholder.innerHTML = versionSelect;
- let selectElement = placeholder.querySelector("select");
- selectElement.addEventListener("change", onSwitch);
- }
-
- const languagePlaceholders = document.querySelectorAll(".language_switcher_placeholder");
- for (placeholder of languagePlaceholders) {
- placeholder.innerHTML = languageSelect;
- let selectElement = placeholder.querySelector("select");
- selectElement.addEventListener("change", onSwitch);
- }
- });
-</script>
+ <script type="text/javascript" src="{{ pathto('_static/rtd_switcher.js', 1) }}"></script>
+ <meta name="readthedocs-addons-api-version" content="1">
{%- endif %}
{% endblock %}