How do I install the Readthedocs Write Config skill?

Run npx skillmds@latest add tomevault-io/readthedocs-write-config in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readthedocs Write Config safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readthedocs Write Config?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readthedocs Write Config free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readthedocs Write Config?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readthedocs Write Config by tomevault-io

Name: Readthedocs Write Config
Author: tomevault-io

Readthedocs Write Config

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. Use when this capability is needed.

tomevault-io Updated Sep 17, 2026

File contents

Write Read the Docs config (v2)

Overview

Write or revise .readthedocs.yaml files for Read the Docs v2 builds. Focus on required fields, correct paths, and supported keys to avoid validation failures.

Workflow

Identify the documentation tool and paths.
- Confirm whether the project uses Sphinx, MkDocs, or something else.
- Collect sphinx.configuration (conf.py) or mkdocs.configuration (mkdocs.yml) paths.
- Confirm the config file location (repo root by default, subdirectory for monorepos).
Choose the build image and tools.
- Set build.os and build.tools when using custom build jobs or commands.
- Choose stable versions; use latest only when asked.
Define dependency installation.
- Use python.install with requirements and/or package install.
- Use conda.environment when the project uses conda, and set build.tools.python accordingly.
Configure the build step.
- Use sphinx or mkdocs settings for standard builds.
- Prefer build.jobs for customization; use build.commands only to fully replace the pipeline.
- If overriding formats, write outputs under $READTHEDOCS_OUTPUT/<format>/.
Add optional settings.
- Set formats for extra outputs (Sphinx only).
- Configure submodules or search only if requested.
Validate against supported keys and required fields.
- Use references/v2-config.md to confirm defaults, allowed values, and constraints.

Quick start templates

For Sphinx, start from assets/sphinx.readthedocs.yaml.
For MkDocs, start from assets/mkdocs.readthedocs.yaml.

Decision notes

Prefer build.jobs over build.commands because it preserves standard steps and supports per-format commands.
Avoid build.apt_packages when using build.commands (not supported together).
Include formats only when the user needs PDF/ePub/HTMLZIP output.
Do not combine submodules.include and submodules.exclude.

Output checklist

version: 2 present.
build.os and build.tools present when required.
sphinx.configuration or mkdocs.configuration path is correct.
All custom build outputs are written to $READTHEDOCS_OUTPUT.
No unsupported keys or typos.

Resources

Reference: references/v2-config.md
Templates: assets/sphinx.readthedocs.yaml, assets/mkdocs.readthedocs.yaml

Docs

https://docs.readthedocs.com/platform/stable/config-file/v2.html

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: readthedocs-write-configdescription: 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. Use when this capability is needed.---# Write Read the Docs config (v2)## OverviewWrite or revise `.readthedocs.yaml` files for Read the Docs v2 builds. Focus on required fields, correct paths, and supported keys to avoid validation failures.## Workflow1. Identify the documentation tool and paths. - Confirm whether the project uses Sphinx, MkDocs, or something else. - Collect `sphinx.configuration` (conf.py) or `mkdocs.configuration` (mkdocs.yml) paths. - Confirm the config file location (repo root by default, subdirectory for monorepos).2. Choose the build image and tools. - Set `build.os` and `build.tools` when using custom build jobs or commands. - Choose stable versions; use `latest` only when asked.3. Define dependency installation. - Use `python.install` with requirements and/or package install. - Use `conda.environment` when the project uses conda, and set `build.tools.python` accordingly.4. Configure the build step. - Use `sphinx` or `mkdocs` settings for standard builds. - Prefer `build.jobs` for customization; use `build.commands` only to fully replace the pipeline. - If overriding formats, write outputs under `$READTHEDOCS_OUTPUT/<format>/`.5. Add optional settings. - Set `formats` for extra outputs (Sphinx only). - Configure `submodules` or `search` only if requested.6. Validate against supported keys and required fields. - Use `references/v2-config.md` to confirm defaults, allowed values, and constraints.## Quick start templates- For Sphinx, start from `assets/sphinx.readthedocs.yaml`.- For MkDocs, start from `assets/mkdocs.readthedocs.yaml`.## Decision notes- Prefer `build.jobs` over `build.commands` because it preserves standard steps and supports per-format commands.- Avoid `build.apt_packages` when using `build.commands` (not supported together).- Include `formats` only when the user needs PDF/ePub/HTMLZIP output.- Do not combine `submodules.include` and `submodules.exclude`.## Output checklist- `version: 2` present.- `build.os` and `build.tools` present when required.- `sphinx.configuration` or `mkdocs.configuration` path is correct.- All custom build outputs are written to `$READTHEDOCS_OUTPUT`.- No unsupported keys or typos.## Resources- Reference: `references/v2-config.md`- Templates: `assets/sphinx.readthedocs.yaml`, `assets/mkdocs.readthedocs.yaml`## Docs- https://docs.readthedocs.com/platform/stable/config-file/v2.html---> Converted and distributed by [TomeVault](https://tomevault.io/claim/readthedocs) — claim your Tome and manage your conversions.

Frequently asked questions