Read the Docs
Official@readthedocs · United States of America
We host the world's documentation
Agent Skills by Read the Docs
Showing 5 vetted skills indexed across 1 GitHub repositories.
readthedocsreadthedocs-build-optimization
Optimize Read the Docs builds by reducing formats and dependencies.
readthedocsreadthedocs-write-config
Create and update Read the Docs v2 configuration files for Sphinx or MkDocs builds.
readthedocsreadthedocs-search-api
Query the Read the Docs Search API for documentation across projects.
readthedocsreadthedocs-build-failure-triage
Correlate Read the Docs build metadata with raw logs to classify failure causes.
readthedocsreadthedocs-project-manager
Manage Read the Docs projects via the RTD API.
Frequently Asked Questions About Read the Docs
FAQPage SchemaWhat specific tasks can be performed using Read the Docs project management?▼
You can programmatically manage project settings, update configuration files for Sphinx or MkDocs, and trigger build processes. These capabilities allow for the synchronization of documentation environments with repository updates and the maintenance of versioned project metadata across multiple documentation sets.
Which technical personas benefit from these documentation management capabilities?▼
Technical writers, documentation engineers, and software developers benefit from these capabilities. These personas use the platform to maintain consistent documentation standards, troubleshoot build failures through log analysis, and ensure that project configurations remain compatible with evolving documentation source requirements.
What are the prerequisites for integrating Read the Docs into a project?▼
Integration requires a project hosted in a version control system and a valid configuration file, specifically formatted for Sphinx or MkDocs. Users must define their build environment, specify dependencies, and ensure the project structure aligns with the platform's build requirements to enable successful documentation rendering.