xref: /qemu/.readthedocs.yml (revision 977542ded7e6b28d2bc077bcda24568c716e393c)
166e7dde1SAlex Bennée# .readthedocs.yml
266e7dde1SAlex Bennée# Read the Docs configuration file
366e7dde1SAlex Bennée# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
466e7dde1SAlex Bennée
566e7dde1SAlex Bennée# Required
666e7dde1SAlex Bennéeversion: 2
766e7dde1SAlex Bennée
8*b16a45bcSAlex Bennée# Set the version of Python and other tools you might need
9*b16a45bcSAlex Bennéebuild:
10*b16a45bcSAlex Bennée  os: ubuntu-22.04
11*b16a45bcSAlex Bennée  tools:
12*b16a45bcSAlex Bennée    python: "3.11"
13*b16a45bcSAlex Bennée
1466e7dde1SAlex Bennée# Build documentation in the docs/ directory with Sphinx
1566e7dde1SAlex Bennéesphinx:
1666e7dde1SAlex Bennée  configuration: docs/conf.py
1766e7dde1SAlex Bennée
18*b16a45bcSAlex Bennée# We recommend specifying your dependencies to enable reproducible builds:
19*b16a45bcSAlex Bennée# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20*b16a45bcSAlex Bennéepython:
21*b16a45bcSAlex Bennée  install:
22*b16a45bcSAlex Bennée    - requirements: docs/requirements.txt
23*b16a45bcSAlex Bennée
2466e7dde1SAlex Bennée# We want all the document formats
2566e7dde1SAlex Bennéeformats: all
26