From ab336d5da8818ccf797d601cd6ce000a55478ae2 Mon Sep 17 00:00:00 2001 From: Tom Krizek Date: Fri, 14 Jul 2023 13:14:49 +0200 Subject: [PATCH 1/2] Add configuration for readthedocs.org readthedocs.org is switching to in-repo configuration file in favor of the deprecated web interface as it allows more flexibility. This also fixes our recent doc build issues, as we're switching to a newer Python which is required by Sphinx. See https://blog.readthedocs.com/migrate-configuration-v2/ (cherry picked from commit a1a0ccda6ed996f32c2effd7644a2120f9d7a5d2) --- .readthedocs.yaml | 20 ++++++++++++++++++++ .reuse/dep5 | 1 + 2 files changed, 21 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..5ea7be0600 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in doc/arm/ with Sphinx +sphinx: + configuration: doc/arm/conf.py + +# Build all formats +formats: all + +# Explicitly set the version of Python and its requirements +python: + install: + - requirements: doc/arm/requirements.txt diff --git a/.reuse/dep5 b/.reuse/dep5 index e7cdd53d57..de59c2f06d 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -153,6 +153,7 @@ Files: **/.clang-format .gitlab-ci.yml .lgtm.yml .pylintrc + .readthedocs.yaml .tsan-suppress .uncrustify.cfg doc/misc/*.zoneopt From 5512e8fd6ba43cbe380ae818ff6ae2464f339642 Mon Sep 17 00:00:00 2001 From: Tom Krizek Date: Tue, 18 Jul 2023 16:12:44 +0200 Subject: [PATCH 2/2] Synchronize Sphinx package version on ReadTheDocs with our CI Related: isc-projects/images!228 --- doc/arm/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/arm/requirements.txt b/doc/arm/requirements.txt index 31c4a44759..3b12ea86fb 100644 --- a/doc/arm/requirements.txt +++ b/doc/arm/requirements.txt @@ -1,5 +1,5 @@ # Make Read the Docs use the exact same package versions as in # registry.gitlab.isc.org/isc-projects/images/bind9:debian-bullseye-amd64 -Sphinx==5.3.0 -docutils==0.17.1 -sphinx_rtd_theme==1.0.0 +Sphinx==6.1.3 +docutils==0.18.1 +sphinx_rtd_theme==1.2.0