Docs: Add documentation for CustomScript addon #12623
Draft
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
Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
Documentation build overview
Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
|
Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for CustomScript addon
Docs: Add documentation for CustomScript addon
Dec 1, 2025
Copilot finished work on behalf of
humitos
December 1, 2025 11:18
humitos
reviewed
Dec 1, 2025
Member
humitos
left a comment
humitos
left a comment
There was a problem hiding this comment.
Looks good with small changes.
Member
There was a problem hiding this comment.
Update the beginning of this file to add "Custom Script" to the initial list of features.
Contributor
Author
There was a problem hiding this comment.
Added "Custom Script" to the initial features list in commit 2abf4e4.
docs/user/addons.rst
Outdated
Comment on lines
436
to
437
| // The event has already fired when custom scripts load. | ||
| // Check for window.ReadTheDocsEventData first. |
Member
There was a problem hiding this comment.
Suggested change
| // The event has already fired when custom scripts load. | |
| // Check for window.ReadTheDocsEventData first. | |
| // The event "readthedocs-addons-data-ready" has been already fired when this script is run. | |
| // We need to check for `window.ReadTheDocsEventData` first, and if it's available | |
| // use that data to call the handler. |
Contributor
Author
There was a problem hiding this comment.
Updated with the suggested comment text in commit 2abf4e4.
docs/user/addons.rst
Outdated
| handleReadTheDocsData(window.ReadTheDocsEventData.data()); | ||
| } | ||
| // Subscribe to the event for future data updates |
Member
There was a problem hiding this comment.
Suggested change
| // Subscribe to the event for future data updates | |
| // After that, we subscribe to the Read the Docs Addons event to access data | |
| // on future dispatchs (e.g. when a URL changes on a SPA) |
Contributor
Author
There was a problem hiding this comment.
Updated with the suggested comment text in commit 2abf4e4.
Member
|
@copilot Fix feedback |
…de comments Co-authored-by: ericholscher <25510+ericholscher@users.noreply.github.com>
Contributor
Author
Fixed all feedback in commit 2abf4e4. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot finished work on behalf of
ericholscher
December 4, 2025 21:15
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.
docs/user/addons.rstwindow.ReadTheDocsEventDataflag for accessing addons dataOriginal prompt
CustomScript#11775💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.