Skip to content

Commit a96f1b6

Browse files
Fix: Linux Foundation broken RTD documentation jobs
Current documentation build jobs in readthedocs are failing. This adds the missing python dependenceis and configuration. Issue: RELENG-5212 Signed-off-by: Matthew Watkins <[email protected]>
1 parent 6cb9613 commit a96f1b6

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

.readthedocs.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.10"
12+
jobs:
13+
post_checkout:
14+
- git fetch --unshallow || true
15+
16+
# Build documentation in the "docs/" directory with Sphinx
17+
sphinx:
18+
configuration: docs/conf.py
19+
20+
# Optionally build your docs in additional formats such as PDF and ePub
21+
formats:
22+
- pdf
23+
- epub
24+
25+
# Optional but recommended, declare the Python requirements required
26+
# to build your documentation
27+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
28+
python:
29+
install:
30+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
breathe
2+
sphinx

0 commit comments

Comments
 (0)