]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: Remove sphinxcontrib-seqdiag Python package from RTD builds
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 5 Jan 2026 06:10:45 +0000 (13:10 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 5 Jan 2026 06:31:23 +0000 (13:31 +0700)
This is a proactive PR to avoid breaking docs builds when Setuptools 81
starts to be used in the RTD builds process.

The sphnixcontrib-seqdiag Python package is not compatible with
Setuptools 81 or later due to use of pkg_resources:
https://setuptools.pypa.io/en/latest/pkg_resources.html

Setuptools 81 release should be imminent, with the Python deprecation
warning stating pkg_resources "removal as early as 2025-11-30".

Seqdiag seems to be unmaintained with the latest update at Pypi in
the year 2021 and also no updates to the seqdiag git repo.

There are no seqdiag directives left in the docs after last seqdiags
were removed in PR #52308.

Two other options would exist for fixing the situation (see PR for
discussion) but this seems to be the suitable one.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
admin/doc-requirements.txt
doc/conf.py

index c350bb63db6e9f2cdc4edacf7ffc9f889b35af78..1cb7af2624f55d836ba44cc46a6bacba644f1a95 100644 (file)
@@ -15,7 +15,6 @@ sphinx_rtd_theme
 Sphinx-Substitution-Extensions
 sphinxcontrib-mermaid
 sphinxcontrib-openapi
-sphinxcontrib-seqdiag
 # m2r2 replaces mistune https://github.com/CrossNox/m2r2?tab=readme-ov-file#m2r-the-original
 m2r2
 natsort
index 21a5902164931268a0195dd5bfe20de2951554b8..1bf69eeb153948d93d9e75b9aada97a0bd1fc78b 100644 (file)
@@ -131,7 +131,6 @@ extensions = [
     'ceph_confval',
     'sphinxcontrib.mermaid',
     'sphinxcontrib.openapi',
-    'sphinxcontrib.seqdiag',
 ]
 
 ditaa = shutil.which("ditaa")
@@ -251,10 +250,6 @@ for c in pybinds:
 openapi_logger = sphinx.util.logging.getLogger('sphinxcontrib.openapi.openapi30')
 openapi_logger.setLevel(logging.WARNING)
 
-# seqdiag
-seqdiag_antialias = True
-seqdiag_html_image_format = 'SVG'
-
 # ceph_confval
 ceph_confval_imports = glob.glob(os.path.join(top_level,
                                               'src/common/options',