From 1a132f454a64f699118dafcdfccb0687317b435e Mon Sep 17 00:00:00 2001
From: Juliana Fajardini <jufajardini@oisf.net>
Date: Thu, 5 Oct 2023 13:13:27 -0300
Subject: [PATCH] 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.
---
 .readthedocs.yaml              | 17 ++++++++++++-----
 doc/userguide/requirements.txt |  1 +
 2 files changed, 13 insertions(+), 5 deletions(-)
 create mode 100644 doc/userguide/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 4455c2901e5..e545e9cf382 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -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
diff --git a/doc/userguide/requirements.txt b/doc/userguide/requirements.txt
new file mode 100644
index 00000000000..483a4e9600b
--- /dev/null
+++ b/doc/userguide/requirements.txt
@@ -0,0 +1 @@
+sphinx_rtd_theme