From e7554ad43f4707277482f280dd4a2c350a0996bc Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 21:44:49 +0100 Subject: [PATCH 01/14] Remove unsupported options --- doc/manual/conf.py.in | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index 63f687f9..65b62b3e 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -111,7 +111,6 @@ pygments_style = 'sphinx' # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_logo = 'resources/nsd-duotone-white.png' html_favicon = 'resources/favicon.ico' html_theme_options = { From d0c5a54062edba327817e41a5a2e2e10f757a80b Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 21:47:58 +0100 Subject: [PATCH 02/14] Remove unsupported theme option --- doc/manual/conf.py.in | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index 65b62b3e..34f0de0a 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -115,7 +115,6 @@ html_logo = 'resources/nsd-duotone-white.png' html_favicon = 'resources/favicon.ico' html_theme_options = { 'logo_only': True, - 'display_version': True, } # Theme options are theme-specific and customize the look and feel of a theme From c6b62c871e6325acbadabbf813f8746a8ddfca1a Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:20:46 +0100 Subject: [PATCH 03/14] Add version to substitutio --- doc/manual/conf.py.in | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index 34f0de0a..a0c22ec9 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -295,4 +295,6 @@ rst_epilog = ".. |pidfile| replace:: @pidfile@\n" \ ".. |configfile| replace:: @nsdconfigfile@\n" \ ".. |logfile| replace:: @logfile@\n" \ ".. |xfrdfile| replace:: @xfrdfile@\n" \ - ".. |zonelistfile| replace:: @zonelistfile@\n" + ".. |zonelistfile| replace:: @zonelistfile@\n" \ + ".. |version| replace:: @version@" + From 1e9a604026dfa3766334452d439f18aaa061c640 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:21:02 +0100 Subject: [PATCH 04/14] Dump versions --- doc/manual/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/manual/requirements.txt b/doc/manual/requirements.txt index 8bb949d6..c43cefe2 100644 --- a/doc/manual/requirements.txt +++ b/doc/manual/requirements.txt @@ -1,6 +1,6 @@ -Sphinx==7.2 +Sphinx==8.1.3 sphinx-version-warning==1.1.2 -sphinx-tabs==3.4.4 +sphinx-tabs==3.4.7 sphinx-copybutton==0.5.2 sphinx-rtd-theme sphinx-notfound-page From 376713dd3121715d327fd63f4707bb6ebd5f3c2d Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:28:40 +0100 Subject: [PATCH 05/14] It was trying to install 2022 instead of 2024 version --- doc/manual/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/requirements.txt b/doc/manual/requirements.txt index c43cefe2..249c6c4a 100644 --- a/doc/manual/requirements.txt +++ b/doc/manual/requirements.txt @@ -5,4 +5,4 @@ sphinx-copybutton==0.5.2 sphinx-rtd-theme sphinx-notfound-page requests -sphinx-substitution-extensions +sphinx-substitution-extensions==2024.10.17 From 5abc0e2fee95ac365fe2f01c1fdcedb7892b6823 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:29:45 +0100 Subject: [PATCH 06/14] fix indent --- doc/manual/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/installation.rst b/doc/manual/installation.rst index 0234bccc..c99006c9 100644 --- a/doc/manual/installation.rst +++ b/doc/manual/installation.rst @@ -51,7 +51,7 @@ and the changelog. In this example we'll use version |version|. Please note that this may not be the latest version currently. .. code-block:: bash - :substitutions: + :substitutions: wget https://nlnetlabs.nl/downloads/nsd/nsd-|version|.tar.gz tar xzf nsd-|version|.tar.gz From 8cf4777084f8af527a0e375655535c487199cfb4 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:34:34 +0100 Subject: [PATCH 07/14] Add rst_prolog! --- doc/manual/conf.py.in | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index a0c22ec9..025f5c4a 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -295,6 +295,9 @@ rst_epilog = ".. |pidfile| replace:: @pidfile@\n" \ ".. |configfile| replace:: @nsdconfigfile@\n" \ ".. |logfile| replace:: @logfile@\n" \ ".. |xfrdfile| replace:: @xfrdfile@\n" \ - ".. |zonelistfile| replace:: @zonelistfile@\n" \ - ".. |version| replace:: @version@" + ".. |zonelistfile| replace:: @zonelistfile@\n" + +# -- Options for substitution extension -------------------------------------- + +rst_prolog = ".. |version| replace:: {version}".format(version = version) From ab49b3b31a6500e8581fa3d7b07b2754e14dd5c6 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 22:37:16 +0100 Subject: [PATCH 08/14] Use @version@ --- doc/manual/conf.py.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index 025f5c4a..64a3c9fa 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -300,4 +300,4 @@ rst_epilog = ".. |pidfile| replace:: @pidfile@\n" \ # -- Options for substitution extension -------------------------------------- -rst_prolog = ".. |version| replace:: {version}".format(version = version) +rst_prolog = ".. |version| replace:: @version@" From 258cf0963e8ff3bbeae6156275fe8a7bc77bd230 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 23:24:30 +0100 Subject: [PATCH 09/14] Extend ChangeLog --- doc/ChangeLog | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/ChangeLog b/doc/ChangeLog index cf8da42d..f672cebe 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +28 October 2024: Melroy + - Merge #404: Introducing Sphinx substitution in code blocks. + As well as other fixes with Sphinx build. + - Update Copyright lines in help output + - Merge #395: Explain zonefile example better + - Merge #394: Fix doc path (fixes "Edit on GitHub" button in the docs) + 24 October 2024: Wouter - Fix #392: Inconsistent documentation about control-interface. - Merge #395: Explain the zonefile example better. From 444e56221f2216a9553f3f26230cde7b23542820 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Mon, 28 Oct 2024 23:25:02 +0100 Subject: [PATCH 10/14] Extend RELNOTES --- doc/RELNOTES | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/RELNOTES b/doc/RELNOTES index de0d31c6..964a2c7c 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -23,6 +23,11 @@ BUG FIXES: - Merge #395: Explain the zonefile example better. - Merge #394: Fix the path to use doc/manual/. - Fix analyzer issue in do_print_cookie_secrets to check for failure. + - Merge #404: Introducing Sphinx substitution in code blocks. + As well as other fixes with Sphinx build. + - Update Copyright lines in help output + - Merge #395: Explain zonefile example better + - Merge #394: Fix doc path (fixes "Edit on GitHub" button in the docs) 4.10.1 ================ From a5b3d8b6e00f17714e27d488f1a7832eedef4818 Mon Sep 17 00:00:00 2001 From: Jeroen Koekkoek Date: Tue, 29 Oct 2024 11:04:53 +0100 Subject: [PATCH 11/14] Correct ChangeLog --- doc/ChangeLog | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index f672cebe..948681c7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,7 +1,7 @@ -28 October 2024: Melroy +28 October 2024: Jeroen - Merge #404: Introducing Sphinx substitution in code blocks. As well as other fixes with Sphinx build. - - Update Copyright lines in help output + - Merge #391: Update Copyright lines in help output - Merge #395: Explain zonefile example better - Merge #394: Fix doc path (fixes "Edit on GitHub" button in the docs) From fb3023b4fd13353bca4e632008a9d6ad8a5e5e32 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Tue, 29 Oct 2024 11:12:51 +0100 Subject: [PATCH 12/14] Correct changelog --- doc/ChangeLog | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 948681c7..cb10b3f3 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,4 +1,4 @@ -28 October 2024: Jeroen +28 October 2024: Melroy - Merge #404: Introducing Sphinx substitution in code blocks. As well as other fixes with Sphinx build. - Merge #391: Update Copyright lines in help output From 492013905062669ee509b829d0d52f043ff2b1a3 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Tue, 29 Oct 2024 11:24:21 +0100 Subject: [PATCH 13/14] Change back to jeroen --- doc/ChangeLog | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index cb10b3f3..948681c7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,4 +1,4 @@ -28 October 2024: Melroy +28 October 2024: Jeroen - Merge #404: Introducing Sphinx substitution in code blocks. As well as other fixes with Sphinx build. - Merge #391: Update Copyright lines in help output From 7b77bfaf95e852869a93a224e1f3bbfc1579a371 Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Tue, 29 Oct 2024 11:37:54 +0100 Subject: [PATCH 14/14] Update doc/ChangeLog Co-authored-by: Willem Toorop --- doc/ChangeLog | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/ChangeLog b/doc/ChangeLog index 948681c7..b11ccaee 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -4,6 +4,7 @@ - Merge #391: Update Copyright lines in help output - Merge #395: Explain zonefile example better - Merge #394: Fix doc path (fixes "Edit on GitHub" button in the docs) + - Many thanks to Melroy van den Berg for the documentation improvements and fixes in PRs #391, #394, #395 and #404 24 October 2024: Wouter - Fix #392: Inconsistent documentation about control-interface.