Fix version warning in documentation #2187
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
heplesser
added
I: No breaking change
|
A single reviewer should be enough for this one. |
jessica-mitchell
approved these changes
Oct 14, 2021
|
@steffengraber: I'm still seeing the warning on https://nest-simulator.readthedocs.io/en/v3.1/. Perhaps the v3.1 docs build needs to be manually triggered to incorporate the changes from this PR? |
|
@clinssen Unfortunately, we can not change the documentation for the current release. These changes will only take effect starting with the next release. |
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.
Problem:
The documentation contains a warning prologue that should only appear in the "latest" version.
Solution:
Readthedocs contains an environment variable "READTHEDOCS_VERSION" at build time which contains the version number that is currently being built. Only if this is "latest" the warning is displayed.
Note: for locally built documentation no warning is shown anymore.