8000 Doc: Render version/language selector on Read the Docs by humitos · Pull Request #116966 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Doc: Render version/language selector on Read the Docs #116966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 17, 2024
Merged

Doc: Render version/language selector on Read the Docs #116966

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc66a22
Doc: render version/language selector on Read the Docs
humitos Mar 18, 2024
6fda95c
Doc: adapt code to use API data v1
humitos Apr 9, 2024
8930549
Doc: add version/language selectors in all the placeholders
humitos Apr 9, 2024
7c27128
Doc: add hardcoded links to the official docs
humitos Apr 9, 2024
00eee90
Doc: refactor code to use data structure v1
humitos Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Doc: render version/language selector on Read the Docs 
Integrate the new Read the Docs Addons JavaScript into the Python Docs Sphinx
theme to render versions and languages selector nicely.

References:

* Discord thread: https://discord.com/channels/935215565872693329/1159601953265942589
* Implementation of Addons JavaScript `CustomEvent`: readthedocs/addons#64
* Conversation about using Read the Docs: python/docs-community#5
  • Loading branch information
@humitos
humitos committed Mar 18, 2024
commit fc66a2280c9589c6adbd1daf09f727c2c35800cd
55 changes: 55 additions & 0 deletions Doc/tools/templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,59 @@
{{ "}" }}
</style>
{{ super() }}

<meta name="readthedocs-addons-api-version" content="0">
<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;
const languageMapping = {
en: "English",
es: "Spanish",
// ...
}

// TODO: add `selected="selected"` to option
const versionSelect = `
<select id="version_select">
${ config.addons.flyout.versions.map(
(version) => `
<option
value="${ version.slug }"
${ config.versions.current.slug === version.slug ? 'selected="selected"' : '' }
data-url="${ version.url }">
${ version.slug }
</option>`
).join("\n") }
</select>
`;

const languageSelect = `
<select id="language_select">
${ config.addons.flyout.translations.map(
(translation) => `
<option
value="${ translation.slug }"
${ config.projects.current.language.code === translation.slug ? 'selected="selected"' : '' }
data-url="${ translation.url }">
${ languageMapping[translation.slug] }
</option>`
).join("\n") }
</select>
`;

const selectVersionElement = document.querySelector("li.switchers div.version_switcher_placeholder");
selectVersionElement.innerHTML = versionSelect;
document.querySelector("li.switchers div.version_switcher_placeholder").addEventListener("change", onSwitch);

const selectLanguageElement = document.querySelector("li.switchers div.language_switcher_placeholder");
selectLanguageElement.innerHTML = languageSelect;
document.querySelector("li.switchers div.language_switcher_placeholder select").addEventListener("change", onSwitch);
});
</script>
{% endblock %}
0