]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Remove the configblock sphinx extension
authorAydın Mercan <aydin@isc.org>
Tue, 17 Jun 2025 08:22:50 +0000 (11:22 +0300)
committerAydın Mercan <aydin@isc.org>
Mon, 23 Jun 2025 10:45:09 +0000 (13:45 +0300)
The `configblock` extension doesn't work with RHEL 8. However, this
extension isn't needed anymore after the RTD fix and can be safely
removed.

bin/named/named.conf.rst
doc/arm/conf.py
doc/ext/configblock.py [deleted file]
doc/ext/meson.build [deleted file]
doc/man/conf.py

index c53ada236b3c5e8368752fe3a8d4a4935aaa3fd7..89e76bd99ca45d80d72c74999d5ff0a447144a26 100644 (file)
@@ -40,19 +40,19 @@ C++ style: // to end of line
 
 Unix style: # to end of line
 
-.. configblock:: options
+.. literalinclude:: ../../doc/misc/options
 
 Any of these zone statements can also be set inside the view statement.
 
-.. configblock:: primary.zoneopt
-.. configblock:: secondary.zoneopt
-.. configblock:: mirror.zoneopt
-.. configblock:: forward.zoneopt
-.. configblock:: hint.zoneopt
-.. configblock:: redirect.zoneopt
-.. configblock:: static-stub.zoneopt
-.. configblock:: stub.zoneopt
-.. configblock:: in-view.zoneopt
+.. literalinclude:: ../../doc/misc/primary.zoneopt
+.. literalinclude:: ../../doc/misc/secondary.zoneopt
+.. literalinclude:: ../../doc/misc/mirror.zoneopt
+.. literalinclude:: ../../doc/misc/forward.zoneopt
+.. literalinclude:: ../../doc/misc/hint.zoneopt
+.. literalinclude:: ../../doc/misc/redirect.zoneopt
+.. literalinclude:: ../../doc/misc/static-stub.zoneopt
+.. literalinclude:: ../../doc/misc/stub.zoneopt
+.. literalinclude:: ../../doc/misc/in-view.zoneopt
 
 Files
 ~~~~~
index fc122c1bf73b974653026ef7ca07e736f8708fc0..a3acd2bf04b4ff01c00dbd7c024f628b98e3bb00 100644 (file)
@@ -139,10 +139,9 @@ def setup(app):
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, make it absolute.
-#
+
 sys.path.append(str(Path(__file__).resolve().parent / "_ext"))
 sys.path.append(str(Path(__file__).resolve().parent.parent / "misc"))
-sys.path.append(str(Path(__file__).resolve().parent.parent / "ext"))
 
 # -- Project information -----------------------------------------------------
 
@@ -169,7 +168,7 @@ release = version
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["namedconf", "rndcconf", "configblock"]
+extensions = ["namedconf", "rndcconf"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
diff --git a/doc/ext/configblock.py b/doc/ext/configblock.py
deleted file mode 100644 (file)
index 368df5b..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
-#
-# SPDX-License-Identifier: MPL-2.0
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0.  If a copy of the MPL was not distributed with this
-# file, you can obtain one at https://mozilla.org/MPL/2.0/.
-#
-# See the COPYRIGHT file distributed with this work for additional
-# information regarding copyright ownership.
-
-from pathlib import Path
-
-from docutils import nodes
-
-from sphinx.application import Sphinx
-from sphinx.util.docutils import SphinxDirective
-from sphinx.util.typing import ExtensionMetadata
-
-
-misc_path = Path(__file__).resolve().parent.parent.parent / "misc"
-
-
-class ConfigBlockDirective(SphinxDirective):
-    required_arguments = 1
-
-    def run(self) -> list[nodes.Node]:
-        target = misc_path / self.arguments[0]
-
-        block = "{}" if not target.exists() else target.read_text()
-
-        return [nodes.literal_block(text=block)]
-
-
-def setup(app: Sphinx) -> ExtensionMetadata:
-    app.add_directive("configblock", ConfigBlockDirective)
-
-    return {
-        "version": "0.1",
-        "parallel_read_safe": True,
-        "parallel_write_safe": True,
-    }
diff --git a/doc/ext/meson.build b/doc/ext/meson.build
deleted file mode 100644 (file)
index eb9532e..0000000
+++ /dev/null
@@ -1,16 +0,0 @@
-# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
-#
-# SPDX-License-Identifier: MPL-2.0
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0.  If a copy of the MPL was not distributed with this
-# file, you can obtain one at https://mozilla.org/MPL/2.0/.
-#
-# See the COPYRIGHT file distributed with this work for additional
-# information regarding copyright ownership.
-
-manrst_srcset.add(
-    files(
-        'configblock.py',
-    ),
-)
index 8a716cb6225593417795a93e37844e85bcd097b4..2ba58b805e4714562c0e22df3c3d6b3e44c379dc 100644 (file)
@@ -28,7 +28,6 @@ from pathlib import Path
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-sys.path.append(str(Path(__file__).resolve().parent.parent / "ext"))
 sys.path.append(str(Path(__file__).resolve().parent.parent / "misc"))
 
 # -- Project information -----------------------------------------------------
@@ -49,7 +48,7 @@ man_make_section_directory = True
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["configblock"]
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["../arm/_templates"]