Doc: Render version/language selector on Read the Docs#116966
Merged
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Integrate the new Read the Docs Addons into the Python Docs Sphinx theme to render versions and languages selector nicely, using the JavaScript
readthedocs-addons-data-readycustom event triggered by the Read the Docs Addons.References:
CustomEvent: API: use<meta>to define supported API version and triggerCustomEventreadthedocs/addons#64I'm opening this PR here as a POC to continue the conversation on the Discord thread linked.
Example
This example was built locally on a development Read the Docs instance. The languages and versions shown in the example are:
It shows
readthedocs-selectorbecause it's the branch where I was making these changes. It showslatest, because I forgot to disable it 😄📚 Documentation preview 📚: https://cpython-previews--116966.org.readthedocs.build/