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

1. 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.