Added a warning when users are reading latest docs. #1800
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
|
AFAIK I cannot set up a test branch within the Arbor RTD project, so I keep around a testing branch hooked up to my own repo (if you write a lot of docs, you could setup your own RTD account linked to your fork of Arbor). Here is your branch (looks good!): https://arbor-rtd-dev.readthedocs.io/en/latest (I discovered the current warning, shown at old-stables, are RTD inserted, there is a setting.) |
brenthuisman
approved these changes
Jan 17, 2022
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.
Helps users notice differences between the API of their installed arbor and the latest docs they are reading online. closes #1789
Tested locally by removing the check, rendered HTML looks OK. Should test either live on RTD, or with a hidden RTD build that checks against itself.