]> 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>
Wed, 11 Feb 2026 05:45:55 +0000 (12:45 +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>
(cherry picked from commit 15481e509b4d644d0644188501d86a4ceda2c039)

admin/doc-requirements.txt
doc/conf.py

index 164896329b7523660918c7445ad0aaaa4dab5495..473485c63d3ce0d165dc9351fa8d349ddf452c3b 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 5293ff1b212601274aef972da178b2b4bd5dfec7..7510115e2a33f441c3372947477b14eb9a6d3639 100644 (file)
@@ -132,7 +132,6 @@ extensions = [
     'ceph_confval',
     'sphinxcontrib.mermaid',
     'sphinxcontrib.openapi',
-    'sphinxcontrib.seqdiag',
 ]
 
 ditaa = shutil.which("ditaa")
@@ -252,10 +251,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',