From 1c0e4afcbfacb4120c9dc98b767bf2613bf2ae15 Mon Sep 17 00:00:00 2001 From: Matthew Watkins Date: Tue, 27 Jan 2026 15:24:01 +0000 Subject: [PATCH] Chore: Remove broken sphinxcontrib-swaggerdoc module 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: I95931e6c7eb3c6571d5d1e6150000d06854f9521 Signed-off-by: Matthew Watkins --- docs/MultiCloud-K8sPlugin-APIv1-Specification.rst | 5 +---- docs/conf.py | 1 - docs/requirements-docs.txt | 1 - 3 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst b/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst index 24dd1ef7..5a2c4a9d 100644 --- a/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst +++ b/docs/MultiCloud-K8sPlugin-APIv1-Specification.rst @@ -18,9 +18,6 @@ The specification of the K8sPlugin v1 API in Swagger format: API Catalog =========== -.. 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:: k8splugin/k8splugin-v1-api-swagger.json diff --git a/docs/conf.py b/docs/conf.py index 4a6b2732..f8cb3d3b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,6 @@ extensions = [ 'sphinx.ext.graphviz', 'sphinxcontrib.blockdiag', 'sphinxcontrib.seqdiag', - 'sphinxcontrib.swaggerdoc', 'sphinxcontrib.plantuml' ] diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 097282b9..a72d6013 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -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 six -- 2.16.6