Retrieve JSON data from an external source #19
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
humitos
force-pushed
the
dynamic-data-from-url
branch
3 times, most recently
from
968c43e to
0c17a31
Compare
Allow the user to define a custom URL to retrieve the JSON data (instead of hitting Read the Docs API) needed to add the banner into the page. This is useful when there is a git tag that doesn't want to be updated, but now the warning message is out of date. So, by defining a custom URL (potentially a JSON under the git repository served by github, for example) this file is retrieved by the documentation and displayed the custom message needed at certain date. The JSON file can be updated independently from the documentation/tag/etc.
humitos
force-pushed
the
dynamic-data-from-url
branch
from
0c17a31 to
469f337
Compare
Owner
Author
|
There is a live example of this at https://sphinx-version-warning-example.readthedocs.io/en/dynamic-message-json/ which use the JSON file from https://github.com/humitos/sphinx-version-warning-example/blob/dynamic-message-json/dynamic-data.json |
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.
Allow the user to define a custom URL to retrieve the JSON data (instead of hitting Read the Docs API) needed to add the banner into the page.
This is useful when there is a git tag that doesn't want to be updated, but now the warning message is out of date. So, by defining a custom URL (potentially a JSON under the git repository served by github, for example) this file is retrieved by the documentation and displayed the custom message needed at certain date.
The JSON file can be updated independently from the documentation/tag/etc.