]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Add configuration for readthedocs.org
authorTom Krizek <tkrizek@isc.org>
Fri, 14 Jul 2023 11:14:49 +0000 (13:14 +0200)
committerTom Krizek <tkrizek@isc.org>
Tue, 18 Jul 2023 13:30:27 +0000 (15:30 +0200)
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/

.readthedocs.yaml [new file with mode: 0644]
.reuse/dep5

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..5ea7be0
--- /dev/null
@@ -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
index 0554a1613b9f63b95a2655c5051c2a589a48819d..ded1db308a26eae67b1d2234ad3980bdc5d6a4cc 100644 (file)
@@ -163,6 +163,7 @@ Files: **/.clang-format
        .gitlab-ci.yml
        .lgtm.yml
        .pylintrc
+       .readthedocs.yaml
        .tsan-suppress
        .uncrustify.cfg
        doc/misc/*.zoneopt