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.
pull/9575/head
Juliana Fajardini 1 year ago committed by Victor Julien
parent 14a4c6c696
commit 1a132f454a

@ -1,11 +1,18 @@
# Required by Read The Docs # Required by Read The Docs
version: 2 version: 2
formats: all build:
os: ubuntu-22.04
tools:
python: "3.11"
python: 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 formats: all
# requirements.txt file.
install: []

@ -0,0 +1 @@
sphinx_rtd_theme
Loading…
Cancel
Save