Fix(deps): Pin setuptools<82 to retain pkg_resources module

Setuptools v82.0.0 removed the bundled pkg_resources module entirely.
This breaks RTD builds because sphinxcontrib-blockdiag (and
sphinxcontrib-seqdiag via blockdiag) import pkg_resources at the
module level, causing:

  ModuleNotFoundError: No module named 'pkg_resources'

Pin setuptools>=65.0.0,<82 in the docs requirements and example
templates to ensure pkg_resources remains available at build time.
Both sphinxcontrib-blockdiag and sphinxcontrib-seqdiag are
unmaintained (last released 2020) and cannot be patched upstream.

Long-term, these diagram extensions should be replaced with
actively maintained alternatives that use importlib.metadata.

Issue-ID: CIMAN-33
Change-Id: I3c5a81ee8ba562d7f0a06c1abc59015ca9003ba3
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index fb5cb33..c159b59 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,5 +1,5 @@
 # Compatibility
-setuptools>=65.0.0
+setuptools>=65.0.0,<82
 Pillow>=10.1.0
 
 # Core Sphinx

diff --git a/examples/sphinx/master/requirements-docs.txt b/examples/sphinx/master/requirements-docs.txt
index 71df2ab..299a413 100644 (file)
--- a/examples/sphinx/master/requirements-docs.txt
+++ b/examples/sphinx/master/requirements-docs.txt
@@ -1,3 +1,4 @@
+setuptools>=65.0.0,<82  # MIT; pinned <82 to retain pkg_resources for blockdiag/seqdiag
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-blockdiag  # BSD

diff --git a/examples/sphinx/release/requirements-docs.txt b/examples/sphinx/release/requirements-docs.txt
index 71df2ab..299a413 100644 (file)
--- a/examples/sphinx/release/requirements-docs.txt
+++ b/examples/sphinx/release/requirements-docs.txt
@@ -1,3 +1,4 @@
+setuptools>=65.0.0,<82  # MIT; pinned <82 to retain pkg_resources for blockdiag/seqdiag
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
 sphinxcontrib-blockdiag  # BSD