Configuration Guide
Customise your Read the Docs projects with our detailed project configuration options.
Configuration Files
All Read the Docs configurations are set through .readthedocs.yml
Project Setup
You can set project options like the documentation builder, Python version, and environment options.
Basic Config
version: 2
sphinx:
builder: html
version: latest
configuration: docs/conf.py
Use the .build format for advanced builds
Configuration Options
- project: project name
- versions
- python environment options
- environment setup options
- custom theme
Advanced Usage
Multi-Project Builds
Multi-version builds
Configuration Options
- subprojects:
- project:
- project1:
- default: main
- default: 12
- python:
- 3
- project2:
- default: dev
- 3.9
- 1
- install:
- requirements: requirements.txt
- project3:
- 3.11
- configuration:
- html
- 3.10
- html_theme:
- html_extra: