ENH: add optional per version url in version-switcher #575
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
tupui
force-pushed
the
version_switcher_url
branch
from
a58caff to
cdb4295
Compare
drammock
approved these changes
Jan 23, 2022
choldgraf
reviewed
Jan 25, 2022
|
|
||
| - ``version``: a version string. This will be inserted into | ||
| ``switcher['url_template']`` to create the links to other docs versions, and | ||
| also checked against ``switcher['version_match']`` to provide styling to the | ||
| switcher. | ||
| - ``name``: an optional name to display in the switcher dropdown instead of the | ||
| version string (e.g., "latest", "stable", "dev", etc). | ||
| - ``url``: an optional URL. If provided, it links the version to ``url`` |
There was a problem hiding this comment.
Could you add an example of this usage in one of the entries in the example below, with a comment like "Note that because url is specified for entry XXX, this URL will be used instead of the automatically-generated one."
There was a problem hiding this comment.
I've added it in an example. But since it's a JSON file I cannot really add a comment no??
damianavila
approved these changes
Jan 27, 2022
There was a problem hiding this comment.
LGTM (modulo @choldgraf is OK with the added example on his comment).
|
@choldgraf can you please take another look? 😃 |
choldgraf
approved these changes
Feb 8, 2022
Co-authored-by: Chris Holdgraf <[email protected]>
|
Thanks! 🎉 |
Merged
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.
Closes #573
Allow to specify
urlinswitcher.json. It would directly link a given version to the specified url and not useurl_template.