diff --git a/doc/ChangeLog b/doc/ChangeLog index cf8da42d..b11ccaee 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,11 @@ +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 + - 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. - Merge #395: Explain the zonefile example better. 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 ================ diff --git a/doc/manual/conf.py.in b/doc/manual/conf.py.in index 63f687f9..64a3c9fa 100644 --- a/doc/manual/conf.py.in +++ b/doc/manual/conf.py.in @@ -111,12 +111,10 @@ 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 = { 'logo_only': True, - 'display_version': True, } # Theme options are theme-specific and customize the look and feel of a theme @@ -298,3 +296,8 @@ rst_epilog = ".. |pidfile| replace:: @pidfile@\n" \ ".. |logfile| replace:: @logfile@\n" \ ".. |xfrdfile| replace:: @xfrdfile@\n" \ ".. |zonelistfile| replace:: @zonelistfile@\n" + + +# -- Options for substitution extension -------------------------------------- + +rst_prolog = ".. |version| replace:: @version@" 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 diff --git a/doc/manual/requirements.txt b/doc/manual/requirements.txt index 8bb949d6..249c6c4a 100644 --- a/doc/manual/requirements.txt +++ b/doc/manual/requirements.txt @@ -1,8 +1,8 @@ -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 requests -sphinx-substitution-extensions +sphinx-substitution-extensions==2024.10.17