forked from openstack-k8s-operators/ci-framework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
27 lines (23 loc) · 751 Bytes
/
.readthedocs.yaml
File metadata and controls
27 lines (23 loc) · 751 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
---
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
pre_build:
- sh scripts/prepare_doc_build_env.sh
- ansible-doc-extractor docs/source/plugins plugins/modules/*.py
- sphinx-apidoc -o docs/source/module_utils -T --implicit-namespaces plugins/module_utils/*/
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/doc-requirements.txt