Addons: load_when_embedded config
#11765
Merged
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
humitos/addons-embedded-http-header
branch
from
00bcd15 to
0fe2246
Compare
Add an extra addons config to decide whether or not force the injection of addons when the page is embedded (eg. iframe). By default, we are not loading addons if embedded. Required by readthedocs/addons#415 Closes readthedocs/addons#412
humitos
changed the title
X-RTD-Load-Addons-When-Embedded HTTP headerload_when_embedded config
humitos
force-pushed
the
humitos/addons-embedded-http-header
branch
from
0fe2246 to
7095954
Compare
agjohnson
approved these changes
Nov 13, 2024
We talked about giving users a way to inject a JavaScript file they
control using our Cloudflare Worker infrastructure to allow them
manipulate frozen documentations.
This could be used in different ways to fix bugs or add features to a
particular frozen set of docs or even to all the versions. The user can
make usage of API data to filter by version or not
(e.g. `if (versions.current == "v3.0") { .. do something ...} `)
The script could live in Read the Docs itself using a relative URL, or
outside it, using an absolute URL.
### Example using Sphinx
1. [Tell Sphinx to include `static`
folder](https://github.com/readthedocs/test-builds/blob/full-feature/docs/conf.py#L25)
2. [Include a `readthedocs.js` file in your
project](https://github.com/readthedocs/test-builds/blob/full-feature/docs/static/readthedocs.js)
3. Make `AddonsConfig.userjsfile_src` to be
`/en/full-feature/readthedocs.js` from addons admin UX
The console will render the following:
Related #11474
Related readthedocs/addons#431
stsewd
reviewed
Nov 18, 2024
Comment on lines
124
to
126
| "configs": { | ||
| "load_when_embedded": false | ||
| }, |
There was a problem hiding this comment.
.com tests will probably need to be updated
There was a problem hiding this comment.
Hrm, I don't think we have this file in .com. At least, I didn't find it
There was a problem hiding this comment.
We have two files in tests/responses/addons/
…thedocs/readthedocs.org into humitos/addons-embedded-http-header
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
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.
Add an extra addons config to decide whether or not force the injection of addons when the page is embedded (eg. iframe). By default, we are not loading addons if embedded.
Required by readthedocs/addons#415
Closes readthedocs/addons#412