DOC: Section on RTD version switcher #1280
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
CIs are failing; it looks like maybe you don't have our pre-commit hooks set up @VeckoTheGecko? See here: https://pydata-sphinx-theme.readthedocs.io/en/latest/community/setup.html#setup-pre-commit |
|
Didn't notice the hooks before. Fixed :^) |
drammock
approved these changes
Apr 11, 2023
drammock
requested changes
Apr 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This clarification confirms this theme supports RTD versioning by default. This is necessary as many users start up with simple projects which may not implement sectioning, which may confuse them as to why the RTD version switcher isn't visible. It reassures its not a bug with their code/docs configuration.
As per discussion at #1005 (comment) . Related to #705
Maintainers feel free to push changes to this branch if desired.