Skills
.Work. You
Rest

readthedocs-search-api

Official

Find docs across projects with the Search API.

Software Engineering#documentation#api#search#query#pagination#project#readthedocs
Authorreadthedocs
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Query the Read the Docs Search API to locate documentation across projects and repositories, enabling programmatic discovery of relevant pages without manual browsing.

Core Features & Use Cases

  • Global search: Query millions of pages across Read the Docs to locate documentation for topics, libraries, or projects.
  • Project-scoped results: Use filters like project:{slug} to narrow results to a specific project.
  • Structured responses & pagination: Navigate through paginated results and extract fields such as project, version, title, path, domain, and highlights.
  • Use Case: Quickly find API docs and related guides for a given project to accelerate onboarding or research.

Quick Start

Set RTD_HOST to your Read the Docs site and query the API endpoint /api/v3/search/?q=<query>&page=<n> to fetch results.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: readthedocs-search-api
Download link: https://github.com/readthedocs/skills/archive/main.zip#readthedocs-search-api

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.