readthedocs-write-config

To create a Read the Docs v2 configuration file for Sphinx, define the required keys including version, build.os, build.tools, python.install, and sphinx.configuration. This standardizes your builds, dependencies, and format options across CI pipelines.

The correct .readthedocs.yaml syntax for MkDocs builds requires specifying version 2, build.os, build.tools, python.install, and the mkdocs.configuration key. This validates your setup and adapts it to CI workflows.

Yes, you can use Read the Docs v2 config for monorepo projects. The configuration supports standardized, versioned builds and includes specific submodules settings to manage dependencies across multi-repo CI pipelines.

To update an existing Read the Docs configuration, modify the YAML file to add or adjust build.images, build.tools, and formats keys. This ensures your v2 config aligns with current Read the Docs guidance and CI workflows.

Yes, Read the Docs v2 config supports conda environments. You can specify conda within the python.install section of your .readthedocs.yaml file to manage complex dependencies for Sphinx or MkDocs builds.

The required keys in a v2 .readthedocs.yaml file are version, build.os, build.tools, python.install, and either sphinx.configuration or mkdocs.configuration. Additional keys like formats and submodules are optional.