xref: /aosp_15_r20/external/libbpf/.readthedocs.yaml (revision f7c14bbac8cf49633f2740db462ea43457973ec4)
1*f7c14bbaSAndroid Build Coastguard Worker# .readthedocs.yaml
2*f7c14bbaSAndroid Build Coastguard Worker# Read the Docs configuration file
3*f7c14bbaSAndroid Build Coastguard Worker# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4*f7c14bbaSAndroid Build Coastguard Worker
5*f7c14bbaSAndroid Build Coastguard Worker# Required
6*f7c14bbaSAndroid Build Coastguard Workerversion: 2
7*f7c14bbaSAndroid Build Coastguard Worker
8*f7c14bbaSAndroid Build Coastguard Workerbuild:
9*f7c14bbaSAndroid Build Coastguard Worker  os: "ubuntu-22.04"
10*f7c14bbaSAndroid Build Coastguard Worker  tools:
11*f7c14bbaSAndroid Build Coastguard Worker    python: "3.11"
12*f7c14bbaSAndroid Build Coastguard Worker
13*f7c14bbaSAndroid Build Coastguard Worker# Build documentation in the docs/ directory with Sphinx
14*f7c14bbaSAndroid Build Coastguard Workersphinx:
15*f7c14bbaSAndroid Build Coastguard Worker  builder: html
16*f7c14bbaSAndroid Build Coastguard Worker  configuration: docs/conf.py
17*f7c14bbaSAndroid Build Coastguard Worker
18*f7c14bbaSAndroid Build Coastguard Workerformats:
19*f7c14bbaSAndroid Build Coastguard Worker  - htmlzip
20*f7c14bbaSAndroid Build Coastguard Worker  - pdf
21*f7c14bbaSAndroid Build Coastguard Worker  - epub
22*f7c14bbaSAndroid Build Coastguard Worker
23*f7c14bbaSAndroid Build Coastguard Worker# Optionally set the version of Python and requirements required to build your docs
24*f7c14bbaSAndroid Build Coastguard Workerpython:
25*f7c14bbaSAndroid Build Coastguard Worker   install:
26*f7c14bbaSAndroid Build Coastguard Worker   - requirements: docs/sphinx/requirements.txt
27