readthedocs-build-failure-triage

Correlate Read the Docs build metadata with raw logs to classify failure causes.

8|4|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/readthedocs/skills --skill readthedocs-build-failure-triage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readthedocs-build-failure-triage
Source: https://github.com/readthedocs/skills/tree/main/skills/readthedocs-build-failure-triage
Command: npx skills add https://github.com/readthedocs/skills --skill readthedocs-build-failure-triage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Triage Read the Docs build failures using build metadata and raw logs to identify failure causes and propose fixes.

Core Features & Use Cases

  • Correlate build metadata with logs to classify failure categories (e.g., dependency install, missing config, tool mismatch).
  • Retrieve raw logs via the RTD API and suggest actionable remediation steps.
  • Apply fixes guidance across projects and builds with clear, repeatable steps.

Quick Start

Provide the RTD_HOST, RTD_TOKEN, and project slug along with build logs or a build URL to begin analysis.

Frequently Asked Questions about readthedocs-build-failure-triage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I diagnose a Read the Docs build failure from logs?

Diagnosing a Read the Docs build failure involves correlating build metadata with raw logs to classify failure categories like dependency install issues or missing configurations and receive actionable remediation steps.

What causes Read the Docs builds to fail?

Read the Docs builds commonly fail due to dependency install errors, missing configuration files, or tool mismatches, which can be identified by correlating build metadata with raw API logs.

Do I need an API token to analyze Read the Docs build logs?

Yes, you need an RTD_HOST, an API token, and a project slug along with build logs or a build URL to operate and provide actionable fixes for Read the Docs failures.

Can I triage historical Read the Docs builds for multiple projects?

Yes, you can triage historical Read the Docs builds across multiple projects by providing the project slug and build URL, applying repeatable fixes across different builds.