Skip to content

Add setuptools version constraint in requirements.txt#262

Merged
uwagura merged 1 commit into
mainfrom
fix/docs-setuptools
Mar 25, 2026
Merged

Add setuptools version constraint in requirements.txt#262
uwagura merged 1 commit into
mainfrom
fix/docs-setuptools

Conversation

@andrew-c-ross

Copy link
Copy Markdown
Contributor

Read the Docs builds started failing March 5 with:

python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/__main__.py", line 13, in <module>
    from sphinx.cmd.build import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 26, in <module>
    from sphinx.application import Sphinx
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 42, in <module>
    from sphinx.registry import SphinxComponentRegistry
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 22, in <module>
    from pkg_resources import iter_entry_points
ModuleNotFoundError: No module named 'pkg_resources'

setuptools version 82.0.0, released Feb 8 2026, removed pkg_resources (https://setuptools.pypa.io/en/latest/history.html#v82-0-0)

This PR adds setuptools<82.0.0 to requirements.txt to attempt to fix this.

Read the Docs builds started failing March 5 with:
```
python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/__main__.py", line 13, in <module>
    from sphinx.cmd.build import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 26, in <module>
    from sphinx.application import Sphinx
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 42, in <module>
    from sphinx.registry import SphinxComponentRegistry
  File "/home/docs/checkouts/readthedocs.org/user_builds/cefi-regional-mom6/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 22, in <module>
    from pkg_resources import iter_entry_points
ModuleNotFoundError: No module named 'pkg_resources'
```

setuptools version 82.0.0, released Feb 8 2026, removed pkg_resources (https://setuptools.pypa.io/en/latest/history.html#v82-0-0)

This PR adds setuptools<82.0.0 to requirements.txt to attempt to fix this.
@andrew-c-ross andrew-c-ross marked this pull request as draft March 18, 2026 17:27
@andrew-c-ross andrew-c-ross marked this pull request as ready for review March 18, 2026 17:47
@andrew-c-ross

Copy link
Copy Markdown
Contributor Author

This does build successfully on my local machine

@uwagura

uwagura commented Mar 25, 2026

Copy link
Copy Markdown
Collaborator

I wanted to run this in my workstation, but I ran into issues with doxygen. In any case, it's a pretty minor change that is documented on the setuptools website, so I think we can go ahead and merge it in

@uwagura uwagura merged commit ff05aec into main Mar 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants