Skip to content

Commit

Permalink
docs: adjust readthedocs config to new options
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jufajardini authored and victorjulien committed Oct 6, 2023
1 parent 14a4c6c commit 1a132f4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
17 changes: 12 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Required by Read The Docs
version: 2

formats: all
build:
os: ubuntu-22.04
tools:
python: "3.11"

python:
version: "3.8"
install:
- requirements: doc/userguide/requirements.txt

sphinx:
builder: html
configuration: doc/userguide/conf.py
fail_on_warning: false

# Use an empty install section to avoid RTD from picking up a non-python
# requirements.txt file.
install: []
formats: all
1 change: 1 addition & 0 deletions doc/userguide/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme

0 comments on commit 1a132f4

Please sign in to comment.