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.
  • Loading branch information
jufajardini committed Oct 5, 2023
1 parent 9157070 commit c160907
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# Required by Read The Docs
version: 2

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

python:
version: "3.8"
install:
- method: pip
path: .
extra_requirements:
- sphinx-rtd-theme

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

0 comments on commit c160907

Please sign in to comment.