conf: add support for sphinx-tabs
Sphinx-tabs is not supported by default from readthedocs.io, hence as
recommended by readthedocs.io, we add it to the conf.py file and the
requirement.txt file.
Also, update the conf.py slight to step up the revision and to follow
the v2 template file from readthedocs.io.
Signed-off-by: Joakim Bech <joakim.bech@linaro.org>
Acked-by: Jerome Forissier <jerome.forissier@linaro.org>
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index bc750dc..7fdc294 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,11 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
version: 2
-# Build from the docs/ directory with Sphinx
-sphinx:
- configuration: conf.py
+# Set the version of Python and other tools you might need
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.10"
-# Explicitly set the version of Python and its requirements
+# Other variants to build than HTML
+formats:
+ - pdf
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: conf.py
+
+# Declare the Python requirements required to build your docs
python:
- version: 3.7
- install:
- - requirements: requirements.txt
+ install:
+ - requirements: requirements.txt
diff --git a/conf.py b/conf.py
index 6823e3b..116b254 100644
--- a/conf.py
+++ b/conf.py
@@ -42,7 +42,8 @@
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.graphviz',
- 'sphinxcontrib.plantuml'
+ 'sphinxcontrib.plantuml',
+ 'sphinx_tabs.tabs',
]
# Add any paths that contain templates here, relative to this directory.
diff --git a/requirements.txt b/requirements.txt
index 867435d..e5b281e 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,4 @@
-sphinx==1.8.5
sphinx_rtd_theme
sphinxcontrib-plantuml
Pillow
+sphinx-tabs==3.4.1