Skip to content

Commit 1a132f4

Browse files
jufajardinivictorjulien
authored andcommitted
docs: adjust readthedocs config to new options
Our documentation was failing to build, seems connected to the new way of indicating build options (cf https://readthedocs.org/projects/suricata/builds/22112658/, https://docs.readthedocs.io/en/stable/config-file/v2.html#build, and https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os). Added the build.os required new field, and adjusted the way python version is passed. For the new configuration style for read the docs, one of the ways to pass extra configuration for python is having a requirements file.
1 parent 14a4c6c commit 1a132f4

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

.readthedocs.yaml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Required by Read The Docs
22
version: 2
33

4-
formats: all
4+
build:
5+
os: ubuntu-22.04
6+
tools:
7+
python: "3.11"
58

69
python:
7-
version: "3.8"
10+
install:
11+
- requirements: doc/userguide/requirements.txt
12+
13+
sphinx:
14+
builder: html
15+
configuration: doc/userguide/conf.py
16+
fail_on_warning: false
817

9-
# Use an empty install section to avoid RTD from picking up a non-python
10-
# requirements.txt file.
11-
install: []
18+
formats: all

doc/userguide/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx_rtd_theme

0 commit comments

Comments
 (0)