docs: Add version switcher #265
Open
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
Use current theme(pydata_sphinx_theme) version switcher dropdown to display a version selector. Because the switcher requires a json, the versions file is parsed into versions.json. Also a css update of the version switcher is required to proper display(vertical scrollbar) the list of versions. Signed-off-by: Nicolae Dicu <[email protected]>
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.
Improvement
Description
Use current theme(pydata_sphinx_theme) version switcher dropdown to display a version selector. Because the switcher requires a json, the versions file is parsed into versions.json.
Also a css update of the version switcher is required to proper display(vertical scrollbar) the list of versions.
Because of a current bug #194 this PR will not show the docs preview. However I created another PR for preview only: https://nicu1989.github.io/score/pr-7/
Here is also a picture of the dropdown:
Also there is a way to view the versions file in browser using the json file: https://eclipse-score.github.io/score/versions.json
Related ticket
closes [#250 ] (improvement ticket)