Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 9, 2025

Documentation Improvement Plan: Skip Build (exit 183) Feature

  • Create new dedicated documentation page for skip build feature at /docs/user/guides/build/skip-build.rst
  • Write comprehensive documentation covering:
    • Introduction and overview of the skip build feature
    • How the feature works (exit code 183 explanation)
    • When to use skip builds
    • Common use cases with examples
    • Best practices and limitations
  • Update /docs/user/guides/build/index.rst to include the new skip build guide
  • Update /docs/user/build-customization.rst to reference the new dedicated page
  • Verify documentation builds successfully
  • Address code review feedback:
    • Fix inverted logic in file type example for clarity
    • Improve mathematical explanation of exit code 183
  • Address additional review feedback:
    • Remove entire "Cancel build based on a condition" section from build-customization.rst
    • Remove extra comments in skip-build.rst examples
    • Revert commit message example to original working command
    • Simplify environment variables section
    • Remove "Test edge cases" section
    • Remove "Further reading" section
    • Fix broken reference in monorepo.rst
    • Remove "Limited to user-defined jobs" section
  • Final review and testing
Original prompt

This section details on the original issue you should resolve

<issue_title>Docs: improve "skip build" (exit 183) documentation</issue_title>
<issue_description>We have this example in our documentation https://docs.readthedocs.io/en/latest/build-customization.html#cancel-build-based-on-a-condition that mentions how to cancel a build based on a particular condition. This is a good example and we have more and more people using it.

However, it does not talk about the feature it self at all. We should probably create a completely new page for this feature and explain it in a more in-deep way. We can grab some ideas from "Netlify's ignore builds" documentation: https://docs.netlify.com/configure-builds/ignore-builds/</issue_description>

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


💡 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.

@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 9, 2025

Documentation build overview

📚 dev | 🛠️ Build #30642268 | 📁 Comparing 65c746d against latest (6990c6e)


🔍 Preview build

No files changed.

@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 9, 2025

Documentation build overview

📚 docs | 🛠️ Build #30631054 | 📁 Comparing 0ff76af against latest (9f74278)


🔍 Preview build

Show files changed (6 files in total): 📝 5 modified | ➕ 1 added | ➖ 0 deleted
File Status
build-customization.html 📝 modified
support.html 📝 modified
about/index.html 📝 modified
tutorial/index.html 📝 modified
guides/build/index.html 📝 modified
guides/build/skip-build.html ➕ added

Copilot AI changed the title [WIP] Add new documentation for skip build feature Add dedicated documentation page for skip build feature (exit 183) Dec 9, 2025
Copilot AI requested a review from humitos December 9, 2025 17:49
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach. @copilot please review my feedback and after that we are probably ready for another reviewer.

Copy link
Contributor Author

Copilot AI commented Dec 10, 2025

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:

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 🎉

@humitos humitos marked this pull request as ready for review December 10, 2025 12:48
@humitos humitos requested a review from a team as a code owner December 10, 2025 12:48
@humitos humitos requested a review from ericholscher December 10, 2025 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: improve "skip build" (exit 183) documentation

2 participants