القائمة
Triage Read the Docs build failures using build logs and config context. Use when a build fails, logs need analysis, or you need fix recommendations.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Optimize Read the Docs build performance and resource usage. Use when Read the Docs builds are slow, timing out, or hitting memory limits, or when users want to speed up builds by adjusting formats, dependencies, conda/mamba usage, or Python API documentation strategy.
Manage Read the Docs projects via the RTD API. Use when creating projects, listing repos, triggering builds, syncing versions, or checking build status on Read the Docs.
Manage Read the Docs redirects via the RTD API. Use when listing, creating, updating, or deleting custom redirects for a project.
Query the Read the Docs Search API to find documentation across projects and repositories. Use when searching documentation, finding related docs, finding API documentation, or gathering information about projects on Read the Docs.
Create or update Read the Docs `.readthedocs.yaml` v2 configuration files for Sphinx or MkDocs builds, including build images/tools, dependency installs, formats, custom build jobs/commands, conda environments, submodules, and search settings. Use when a user asks for a Read the Docs config file, YAML changes, or build behavior updates.
Full Read the Docs API v3 client guidance. Use when building or updating an API client, generating requests, or answering questions about Read the Docs API v3 endpoints (projects, versions, builds, subprojects, translations, redirects, environment variables, organizations, remote VCS resources, or embed content).
| name | readthedocs-build-failure-triage |
| description | Triage Read the Docs build failures using build logs and config context. Use when a build fails, logs need analysis, or you need fix recommendations. |
Use RTD build metadata plus raw build logs to identify the failure category and recommend fixes. This is a diagnostic workflow, not just API wrapping.
RTD_HOST
https://app.readthedocs.orghttps://app.readthedocs.comRTD_TOKEN (preferred) or provided by the usersphinx.fail_on_warning to make them visible.Latest build:
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/builds/?limit=1"
Specific build:
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/builds/123456/"
Use the urls.build value from the API to open the build page. From there,
use the "View raw" link to copy the full log.
Read the Docs exposes raw build logs via the API v2 text endpoint:
GET ${RTD_HOST}/api/v2/build/{build_id}.txt
Example:
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v2/build/123456.txt"
Symptoms: pip install errors, missing packages, resolver conflicts.
Actions:
python.install requirements path in .readthedocs.yaml.python.install:
method: pippath: .Symptoms: conf.py not found, mkdocs.yml not found.
Actions:
sphinx.configuration or mkdocs.configuration paths.Symptoms: Sphinx config but MkDocs project (or vice versa).
Actions:
.readthedocs.yaml uses the right tool block.Symptoms: build fails after enabling warnings-as-errors.
Actions:
sphinx.fail_on_warning.Symptoms: build timeouts, memory errors, OOM kills.
Actions:
Symptoms: only a tag/branch fails.
Actions:
default_branch and version slugs.