-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Support RTD version selector #8
Comments
Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗 |
The pydata theme should support RTD dropdowns out of the box...that is weird! Do you see any errors in the JavaScript console? |
There are no javascript errors. I've found the original pydata-sphinx-theme PR: pydata/pydata-sphinx-theme#436 The list of versions is manually managed, it's not automatically detected: The pydata-sphinx-theme release process includes this as a step:
|
The JSON switcher is a way to manually have a version switcher if you don't want to use the RTD one (and if you manually want to maintain versions in a single JSON). So maybe there's a feature flag for the RTD one too? |
Proposed change
Older versions of the JupyterHub docs e.g. 3.0.0 had a version selector, allowing you to switch to other versions of the docs.
This seems to have been lost in JupyterHub 3.1.0, probably with the switch to the pydata theme?
Alternative options
Do nothing
Who would use this feature?
Users wanting to view docs for versions of JupyterHub other than the latest
(Optional): Suggest a solution
Instructions in pydata for enabling the version switcher:
https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html
The main requirement seems to be a JSON file with a fixed URL containing the list of versions. Is this file automatically created by readthedocs, and can we automatically set this URL?
The text was updated successfully, but these errors were encountered: