Skip to content

The pinned version of Sphinx for 3.10 needs pkg_resources #145455

Closed
Closed
The pinned version of Sphinx for 3.10 needs pkg_resources#145455
Assignees
encukou
Labels
docsDocumentation in the Doc dirinfraCI, GitHub Actions, buildbots, Dependabot, etc.type-bugAn unexpected behavior, bug, or error

Description

@encukou
encukou
opened on Mar 3, 2026

Bug report

Bug description:

On 3.10, Doc/requirements.txt pins Sphinx==3.4.3, which needs pkg_resources. Setuptools docs advise pinning to an older version of setuptools.

This causes builds to fail with an opaque error: the makefile suppresses output of blurb help and sphinx-build --version, and assumes that any failure means that the tools are missing:

mkdir -p build

Missing the required blurb or sphinx-build tools.
Please run 'make venv' to install local copies.

make: *** [Makefile:51: build] Error 1
make: Leaving directory '/home/runner/work/cpython/cpython/Doc'

CPython versions tested on:

3.10

Operating systems tested on:

No response

Linked PRs

Activity

  1. encukou
    self-assigned this
    on Mar 3, 2026
  2. encukou
    added
    type-bugAn unexpected behavior, bug, or error
    docsDocumentation in the Doc dir
    infraCI, GitHub Actions, buildbots, Dependabot, etc.
    on Mar 3, 2026
  3. github-project-automation
    added this to docs issueson Mar 3, 2026
  4. github-project-automation
    moved this to Todo in docs issueson Mar 3, 2026
  5. encukou
    added 2 commits that reference this issue on Mar 3, 2026

    [3.10] pythongh-145455: Constrain setuptools to a version with pkg_re…

    98e934e

    pythongh-145455: Show output of blurb & sphinx-build version commands

    bd86b7e

  6. hugovk commented on Mar 3, 2026

    @hugovk
    hugovk
    on Mar 3, 2026
    Member

    This causes builds to fail with an opaque error: the makefile suppresses output of blurb help and sphinx-build --version, and assumes that any failure means that the tools are missing:

    Yeah, that is annoying, I've run into it in the past. Perhaps we should replace version checks with something like which blurb and which sphinx-build instead?

  7. encukou commented on Mar 3, 2026

    @encukou
    encukou
    on Mar 3, 2026
    MemberAuthor

    See the second PR for what I'd do :)

  8. encukou
    added a commit that references this issue on Mar 3, 2026

    gh-145455: Show output of blurb & sphinx-build version commands (GH-1…

    f1de65b
  9. miss-islington
    added 2 commits that reference this issue on Mar 3, 2026

    pythongh-145455: Show output of blurb & sphinx-build version commands (…

    73a8b84

    pythongh-145455: Show output of blurb & sphinx-build version commands (…

    060b701
  10. encukou
    added a commit that references this issue on Mar 3, 2026

    [3.13] gh-145455: Show output of blurb & sphinx-build version commands (

    0a239dd
  11. w-hsiung
    added a commit that references this issue on Mar 3, 2026

    [3.14] pythongh-145455: Show output of blurb & sphinx-build version c…

    85f8073
  12. miss-islington
    added a commit that references this issue on Mar 4, 2026

    pythongh-145455: Show output of blurb & sphinx-build version commands (…

    40e90da
  13. hugovk
    added 4 commits that reference this issue on Mar 5, 2026

    [3.10] gh-145455: Constrain setuptools to a version with pkg_resources (

    1b49478

    [3.10] gh-145455: Show output of blurb & sphinx-build version commands (

    ba6eba5

    [3.12] gh-145455: Show output of blurb & sphinx-build version commands (

    57cc1bd

    [3.11] gh-145455: Show output of blurb & sphinx-build version commands (

    c7ab95a

  14. hugovk commented on Mar 5, 2026

    @hugovk
    hugovk
    on Mar 5, 2026
    Member

    Thanks, all merged, and https://docs.python.org/3.10/ is now 3.10.20!

  15. hugovk
    closed this as completedon Mar 5, 2026
  16. ljfp
    added a commit that references this issue on Apr 25, 2026

    pythongh-145455: Show output of blurb & sphinx-build version commands (…

    bda797e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirinfraCI, GitHub Actions, buildbots, Dependabot, etc.type-bugAn unexpected behavior, bug, or error

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions