القائمة
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.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
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.
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 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-project-manager |
| description | 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. |
Use the Read the Docs API to create and manage projects. This skill covers the core project lifecycle tasks that are commonly needed for setup and verification.
RTD_HOST
https://app.readthedocs.orghttps://app.readthedocs.comRTD_TOKEN (preferred) or provided by the userBase URL:
${RTD_HOST}/api/v3/
All authenticated requests:
-H "Authorization: Token $RTD_TOKEN"
Use this when you need to verify repo access or pick a repo from integrations.
GET /api/v3/remote/repositories/
Example:
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/remote/repositories/"
POST /api/v3/projects/
Minimal body:
{
"name": "Project Name",
"slug": "project-slug",
"repository": {
"url": "https://github.com/org/repo",
"type": "git"
}
}
Example:
curl -s -X POST "${RTD_HOST}/api/v3/projects/" \
-H "Authorization: Token $RTD_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Project Name","slug":"project-slug","repository":{"url":"https://github.com/org/repo","type":"git"}}'
POST /api/v3/projects/{slug}/sync-versions/
curl -s -X POST \
-H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/sync-versions/"
POST /api/v3/projects/{slug}/versions/{version}/builds/
curl -s -X POST \
-H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/versions/latest/builds/"
GET /api/v3/projects/{slug}/builds/?limit=1
curl -s -H "Authorization: Token $RTD_TOKEN" \
"${RTD_HOST}/api/v3/projects/project-slug/builds/?limit=1"