Docs: Add documentation for CustomScript addon #12623

Copilot · 2025-12-01T11:09:13Z

Original prompt

This section details on the original issue you should resolve

<issue_title>Addons: add documentation for CustomScript</issue_title>
<issue_description>We need to document this addon and put some examples on how to solve common issues with this feature.

Refs: Adddons: allow injecting an "always live" JavaScript file #11758

Requires: Addons: serve the file from Read the Docs for CustomScript #11774

Requires: Addons: add UI for CustomScript ext-theme#527

Requires: API: save a "flag" on window object addons#474</issue_description>

<agent_instructions>We want to document this feature, even it's not exposed in the UI. Tell people to contact support if they want to make usage of this feature.

Explain the flag we expose in window object.

Mention an example of what this feature is useful for.</agent_instructions>

Comments on the Issue (you are @copilot in this section)
@ericholscher We actually aren't exposing this to users -- should we, and write docs for it? @humitos Yeah. I think it's fine to have small docs for this addon. It's not polished/perfect, but it's useful. We can add the other features mentioned in the description of the issue in the following iteration when more people are using it and requesting for upgrades.

Fixes Addons: add documentation for 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.

Co-authored-by: humitos <244656+humitos@users.noreply.github.com>

read-the-docs-community · 2025-12-01T11:15:59Z

Documentation build overview

📚 docs | 🛠️ Build #30623930 | 📁 Comparing 00cecf6 against latest (82b22b0)

🔍 Preview build

Show files changed (3 files in total): 📝 2 modified | ➕ 1 added | ➖ 0 deleted

File	Status
addons.html	📝 modified
custom-script.html	➕ added
reference/git-integration.html	📝 modified

Co-authored-by: humitos <244656+humitos@users.noreply.github.com>

humitos

Looks good with small changes.

docs/user/addons.rst

ericholscher · 2025-12-04T21:11:26Z

@copilot Fix feedback

…de comments Co-authored-by: ericholscher <25510+ericholscher@users.noreply.github.com>

Copilot · 2025-12-04T21:14:29Z

@copilot Fix feedback

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:

blog.readthedocs.com
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
dev.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.djangoproject.com
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.jupyter.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.poliastro.space
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.python.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
executablebooks.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
ipyleaflet.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
ipywidgets.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
jupyterbook.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
jupytext.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
myst-nb.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
myst-parser.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
nbsphinx.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
rst-to-myst.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
www.sphinx-doc.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
www.writethedocs.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

read-the-docs-community · 2025-12-04T21:15:03Z

Documentation build overview

📚 dev | 🛠️ Build #30623929 | 📁 Comparing 00cecf6 against latest (82b22b0)

🔍 Preview build

Show files changed (25 files in total): 📝 1 modified | ➕ 24 added | ➖ 0 deleted

File	Status
http-routingtable.html	➕ added
index.html	📝 modified
design/apiv3.html	➕ added
design/better-doc-urls-handling.html	➕ added
design/build-images.html	➕ added
design/embed-api.html	➕ added
design/file-tree-diff.html	➕ added
design/flyout-redesign.html	➕ added
design/future-builder.html	➕ added
design/in-doc-search-ui.html	➕ added
design/index.html	➕ added
design/new-notifications-system.html	➕ added
design/new-search-api.html	➕ added
design/new-sphinx-guides.html	➕ added
design/organizations.html	➕ added
design/pr-builder.html	➕ added
design/privacy-levels.html	➕ added
design/redirects.html	➕ added
design/refactor-remote-repository.html	➕ added
design/secure-api-access-from-builders.html	➕ added
design/sphinx-jquery.html	➕ added
design/system-packages.html	➕ added
design/telemetry.html	➕ added
design/theme-context.html	➕ added
design/yaml-file.html	➕ added

humitos

Looks good to me!

docs/user/addons.rst

Co-authored-by: humitos <244656+humitos@users.noreply.github.com>

Copilot · 2025-12-09T09:30:51Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

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:

blog.readthedocs.com
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
dev.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.djangoproject.com
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.jupyter.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.poliastro.space
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.python.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
docs.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
executablebooks.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
ipyleaflet.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
ipywidgets.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
jupyterbook.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
jupytext.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
myst-nb.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
myst-parser.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
nbsphinx.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
rst-to-myst.readthedocs.io
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
www.sphinx-doc.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)
www.writethedocs.org
- Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html -d _build/user/doctrees -T -j auto -W . _build/user/html (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

humitos · 2025-12-09T09:32:55Z

@ericholscher pinging you for a review here 👍🏼

ericholscher

Simple enough.

ericholscher · 2025-12-09T15:57:44Z

docs/user/index.rst

   /server-side-search/index
   /server-side-search/syntax
   /flyout-menu
+   /custom-script


This should go in another TOC -- maintaining I'd say.

Good point! I will move it there.

Initial plan

6db7b8e

Copilot AI assigned Copilot and humitos Dec 1, 2025

Copilot started work on behalf of humitos December 1, 2025 11:09 View session

Add documentation for CustomScript addon feature

9ed281a

Co-authored-by: humitos <244656+humitos@users.noreply.github.com>

Improve clarity in CustomScript documentation

013e2bf

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 AI requested a review from humitos December 1, 2025 11:18

Copilot finished work on behalf of humitos December 1, 2025 11:18

humitos reviewed Dec 1, 2025

View reviewed changes

docs/user/addons.rst Show resolved Hide resolved

docs/user/addons.rst Outdated Show resolved Hide resolved

docs/user/addons.rst Outdated Show resolved Hide resolved

Copilot started work on behalf of ericholscher December 4, 2025 21:11 View session

Address PR feedback: add Custom Script to features list and update co…

2abf4e4

…de comments Co-authored-by: ericholscher <25510+ericholscher@users.noreply.github.com>

Copilot AI requested a review from ericholscher December 4, 2025 21:15

Copilot finished work on behalf of ericholscher December 4, 2025 21:15

humitos marked this pull request as ready for review December 9, 2025 09:22

humitos requested a review from a team as a code owner December 9, 2025 09:22

humitos approved these changes Dec 9, 2025

View reviewed changes

humitos reviewed Dec 9, 2025

View reviewed changes

docs/user/addons.rst Outdated Show resolved Hide resolved

Copilot started work on behalf of humitos December 9, 2025 09:26 View session

Move Custom Script section to separate file custom-script.rst

6d3895e

Co-authored-by: humitos <244656+humitos@users.noreply.github.com>

Copilot AI requested a review from humitos December 9, 2025 09:31

Copilot finished work on behalf of humitos December 9, 2025 09:31

Add file to the index

00cecf6

humitos enabled auto-merge (squash) December 9, 2025 09:32

ericholscher approved these changes Dec 9, 2025

View reviewed changes

humitos merged commit 672ece5 into main Dec 9, 2025
11 checks passed

humitos deleted the copilot/add-customscript-documentation branch December 9, 2025 15:57

Uh oh!

Docs: Add documentation for CustomScript addon #12623

Docs: Add documentation for CustomScript addon #12623

Conversation

Copilot AI commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

read-the-docs-community bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

humitos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ericholscher commented Dec 4, 2025

Uh oh!

Copilot AI commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

read-the-docs-community bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

humitos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Dec 9, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

humitos commented Dec 9, 2025

Uh oh!

ericholscher left a comment

Choose a reason for hiding this comment

Uh oh!

ericholscher Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

humitos Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 1, 2025 •

edited

Loading

read-the-docs-community bot commented Dec 1, 2025 •

edited

Loading

Copilot AI commented Dec 4, 2025 •

edited

Loading

read-the-docs-community bot commented Dec 4, 2025 •

edited

Loading