]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
docs(rec): Fix building PDF and json schema refs
authorPieter Lexis <pieter.lexis@powerdns.com>
Fri, 30 Jan 2026 11:40:46 +0000 (12:40 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Mon, 23 Mar 2026 09:32:46 +0000 (10:32 +0100)
pdns/recursordist/docs/.gitignore
pdns/recursordist/docs/Makefile.sphinx
pdns/recursordist/docs/conf.py
pdns/recursordist/docs/generate-jsonschema.py [new symlink]
pdns/recursordist/docs/security-advisories/powerdns-advisory-2014-01.rst

index fd7ed220e9d299adab36780bfd7f35ca50ae99c2..fa393ff4619b8ccf178ae2fe2acfe444310b0c88 100644 (file)
@@ -2,3 +2,4 @@ _build
 /settings.rst
 /yamlsettings.rst
 /rec-metrics-gen.rst
+http-api/recursor-generated-schema.yaml
index a121f032e3b04678e97d650317b00498a59efc89..2d90fd238e95b90681f75f9e1ceba5e33479ced4 100644 (file)
@@ -12,11 +12,14 @@ BUILDDIR      = _build
 help: .venv
        @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile.sphinx
+.PHONY: help Makefile.sphinx generate-jsonschema.py http-api/authoritative-api-swagger.yaml
+
+http-api/recursor-generated-schema.yaml: .venv generate-jsonschema.py http-api/authoritative-api-swagger.yaml
+       .venv/bin/python ./generate-jsonschema.py http-api/authoritative-api-swagger.yaml $@ 
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile.sphinx .venv
+%: Makefile.sphinx .venv http-api/recursor-generated-schema.yaml
        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .venv:
index 57c08ef6b30e86391fc496bc0a5c8595450031c4..30485f1797df40b6a07009f622631a6075d88266 100644 (file)
@@ -119,8 +119,8 @@ changelog_hide_tags_in_entry = True
 
 # -- Options for the Sphinx-Immaterial JSON Domain ------------------------
 json_schemas = [
-    "http-api/authoritative-api-swagger.yaml",
     "http-api/recursor-schema.yaml",
+    "http-api/recursor-generated-schema.yaml",
 ]
 
 # -- Options for HTML output ----------------------------------------------
diff --git a/pdns/recursordist/docs/generate-jsonschema.py b/pdns/recursordist/docs/generate-jsonschema.py
new file mode 120000 (symlink)
index 0000000..2cc8719
--- /dev/null
@@ -0,0 +1 @@
+../../../docs/generate-jsonschema.py
\ No newline at end of file
index d5ff1ac0851ec195cbd176b0bbd1a0c4331cfd1d..2e164bcd8f260bebafb9eb82f6efc7adaf62af49 100644 (file)
 -  Risk of system compromise: No
 -  Solution: Upgrade to PowerDNS Recursor 3.6.1
 -  Workaround: Restrict service using
-   |allow-from|_, install
+   :ref:`setting-allow-from`, install
    script that restarts PowerDNS
 
-.. |allow-from| replace:: ``allow-from``
-.. _allow-from: :ref:`setting-allow-from`
-
 Recently, we've discovered that PowerDNS Recursor 3.6.0 (but NOT
 earlier) can crash when exposed to a specific sequence of malformed
 packets. This sequence happened spontaneously with one of our largest