]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
docs(auth): update sphinxcontrib-openapi and squelch HTTP rendering warning
authorPieter Lexis <pieter.lexis@powerdns.com>
Mon, 23 Feb 2026 10:34:31 +0000 (11:34 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Mon, 23 Mar 2026 09:34:54 +0000 (10:34 +0100)
docs/conf.py
docs/requirements.in
docs/requirements.txt

index 926388c85f5e7325c3f38275c2bdfe5a9528c27e..a24521029d67e7903b77d1804e3310ccefac0da3 100644 (file)
@@ -127,6 +127,12 @@ changelog_hide_tags_in_entry = True
 # -- Options for the Sphinx-Immaterial JSON Domain ------------------------
 json_schemas = ["http-api/swagger/authoritative-api-schema.yaml"]
 
+# -- Options for the HTTP Domain ------------------------
+# Because we use 'default' in the OpenAPI definition for responses, the HTTP domain
+# complains that 'default' is not an integer. So let's suppress those warnings.
+http_strict_mode = False
+suppress_warnings = ["misc.highlighting_failure"]
+
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
index 41023cf99a1d7c5933504fc59019dc093178a772..0e866c5087c8936a02e24f6d6329798c198d34b3 100644 (file)
@@ -7,7 +7,7 @@ Sphinx>=8.2,<9
 
 sphinx-immaterial [json]>=0.13,<0.14
 setuptools-git==1.2
-sphinxcontrib-openapi==0.8.4
+sphinxcontrib-openapi==0.9.0
 changelog>=0.6,<0.7
 sphinxcontrib-fulltoc
 pbr # setup-requires for sphinxcontrib-fulltoc
index fe18e08eaffe03048d4f70cd03aba91e9b92834c..a933aef22697ac18f271c44bbaa3bac367f8d3ca 100644 (file)
@@ -696,9 +696,9 @@ sphinxcontrib-jsmath==1.0.1 \
     --hash=sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178 \
     --hash=sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8
     # via sphinx
-sphinxcontrib-openapi==0.8.4 \
-    --hash=sha256:50911c18d452d9390ee3a384ef8dc8bde6135f542ba55691f81e1fbc0b71014e \
-    --hash=sha256:df883808a5b5e4b4113ad697185c43a3f42df3dce70453af78ba7076907e9a20
+sphinxcontrib-openapi==0.9.0 \
+    --hash=sha256:19037dc091e741b2f84e9c17ff201f70f2ac5c192c883e055bb2d96e9facfbdf \
+    --hash=sha256:c3c445a13c99706d8837b21b78e1caa8be5eb16b8f83a297a1fdf19f1c31d487
     # via -r requirements.in
 sphinxcontrib-qthelp==2.0.0 \
     --hash=sha256:4fe7d0ac8fc171045be623aba3e2a8f613f8682731f9153bb2e40ece16b9bbab \