Allow setting release-specific navbar link mode #63
Conversation
This file contains hidden or 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
jklymak
reviewed
Mar 24, 2023
mpl_sphinx_theme/__init__.py
Outdated
|
|
||
| def setup_html_page_context(app, pagename, templatename, context, doctree): | ||
| """Add a mpl_path template function.""" | ||
| # Pick link setting based on release mode. |
Member
There was a problem hiding this comment.
Can this get more explanation? I'm not sure what is going on here and why...
Member
Author
There was a problem hiding this comment.
Sure, I've expanded on the comments.
For non-main documentation (e.g., `mpl-third-party`), we want the navbar to use absolute links (`https://matplotlib.org/...`) for local development, but when released on the website, it should use `/stable/...` links.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
For non-main documentation (e.g.,
mpl-third-party), we want the navbar to use absolute links (https://matplotlib.org/...) for local development, but when released on the website, it should use/stable/...links. This ensures that the navbar links are never broken.