New CustomScript addon
#431
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
This is a new addon that allow users to inject a specific JavaScript file to all the versions to all the documentation pages to allow them to fix issues in old "frozen" (not able to re-build) versions. Requires readthedocs/readthedocs.org#11758
|
I'm not adding Web UI for this addon yet, so it won't be exposed to users. However, we can test it by our own first or talk to some users wanting to edit/modify old "frozen" documentation versions:
|
agjohnson
approved these changes
Nov 13, 2024
There was a problem hiding this comment.
The code here looks great, I did raise some questions at readthedocs/readthedocs.org#11758 -- namely the feature naming could be reflected here.
humitos
added a commit
to readthedocs/readthedocs.org
that referenced
this pull request
Nov 18, 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
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.
This is a new addon that allow users to inject a specific JavaScript file to all the versions to all the documentation pages to allow them to fix issues in old "frozen" (not able to re-build) versions.
Requires readthedocs/readthedocs.org#11758