Chore: Remove broken sphinxcontrib-swaggerdoc module 28/143028/1
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 27 Jan 2026 15:16:37 +0000 (15:16 +0000)
committerMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 27 Jan 2026 15:16:48 +0000 (15:16 +0000)
This Python module is no longer maintained and will not allow us to
update to more modern Python versions in the docs jobs.

Issue-ID: CIMAN-33
Change-Id: I97f076a14f6ac938cdd1fc11d320d04c6ec97b82
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
docs/api-reference/bp-processor.rst
docs/conf.py
docs/requirements-docs.txt

index efb56b1..cd9d671 100644 (file)
@@ -153,10 +153,7 @@ HTTP Status 202 OK
 API Reference
 --------------
 
-.. warning::
-   In the used Sphinx plugin `sphinxcontrib-swaggerdoc` some information of the swagger file is not
-   rendered completely, e.g. the request body. Use your favorite Swagger Editor and paste the swagger file
-   to get a complete view of the API reference, e.g. on https://editor.swagger.io/.
+
 
 .. swaggerv2doc:: media/cds-bp-processor-api-swagger.json
 
index 8ffa7a7..a6c20e4 100644 (file)
@@ -21,7 +21,6 @@ extensions = [
     'sphinx.ext.graphviz',
     'sphinxcontrib.blockdiag',
     'sphinxcontrib.seqdiag',
-    'sphinxcontrib.swaggerdoc',
     'sphinxcontrib.plantuml',
     'sphinx_tabs.tabs'
 ]
index 915e33c..e9abe26 100644 (file)
@@ -2,7 +2,6 @@ sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-blockdiag  # BSD
 sphinxcontrib-seqdiag # BSD
-sphinxcontrib-swaggerdoc
 sphinxcontrib-spelling
 sphinxcontrib-plantuml
 sphinx-tabs