Skip to content

KeyError: 'soft-deprecated' with make changes #155095

Closed
Closed
KeyError: 'soft-deprecated' with make changes#155095
Assignees
StanFromIreland
Labels
docsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

Description

@syphyr
syphyr
opened on Aug 2, 2026

Bug report

Bug description:

The following command fails when build sphinx doc:

make -C Doc changes

The is causes by the following commit: 5b33424

Traceback

Traceback (most recent call last):
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/cmd/build.py", line 432, in build_main
    app.build(args.force_all, args.filenames)
    ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/application.py", line 426, in build
    self.builder.build_update()
    ~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/builders/__init__.py", line 372, in build_update
    self.build(['__all__'], summary=to_build, method='update')
    ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/builders/__init__.py", line 454, in build
    self.write(docnames, updated_docnames, method)
    ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/builders/__init__.py", line 735, in write
    self.write_documents(docnames)
    ~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^
  File "/home/cbot/.local/lib/python3.14/site-packages/sphinx/builders/changes.py", line 61, in write_documents
    ttext = self.typemap[changeset.type]
            ~~~~~~~~~~~~^^^^^^^^^^^^^^^^
KeyError: 'soft-deprecated'

CPython versions tested on:

3.14

Operating systems tested on:

Linux

Linked PRs

Activity

  1. syphyr
    added
    type-bugAn unexpected behavior, bug, or error
    on Aug 2, 2026
  2. syphyr
    added a commit that references this issue on Aug 2, 2026

    Add soft-deprecated to site-packages

    b2af8da

  3. StanFromIreland commented on Aug 2, 2026

    @StanFromIreland
    StanFromIreland
    on Aug 2, 2026
    Member

    Please provide the full logs, as it will include Sphinx and Python versions and other details. Does it only happen for you on the 3.14 branch? Our documentation builds run correctly, do you need patches to the documentation to make it crash?

  4. StanFromIreland
    added
    docsDocumentation in the Doc dir
    on Aug 2, 2026
  5. github-project-automation
    added this to docs issueson Aug 2, 2026
  6. github-project-automation
    moved this to Todo in docs issueson Aug 2, 2026
  7. StanFromIreland
    added
    pendingThe issue will be closed if no feedback is provided
    on Aug 2, 2026

  8. StanFromIreland commented on Aug 2, 2026

    @StanFromIreland
    StanFromIreland
    on Aug 2, 2026
    Member

    Ah, I didn't notice you were running make changes (I forgot we still have that, I'm not sure we use it anywhere, out of curiosity what do you use it for?), I can reproduce it.

  9. syphyr commented on Aug 2, 2026

    @syphyr
    syphyr
    on Aug 2, 2026
    Author

    Please provide the full logs, as it will include Sphinx and Python versions and other details. Does it only happen for you on the 3.14 branch? Our documentation builds run correctly, do you need patches to the documentation to make it crash?

    This only happens on the 3.14 branch since it is caused by 5b33424

    To reproduce, run the following command:

    make -C Doc changes

    There are no patches required to cause the build error. This is because soft-deprecated in not defined in changes.py in site-packages.

    This fixes the build issue: #155096

  10. StanFromIreland
    self-assigned this
    on Aug 2, 2026
  11. StanFromIreland
    removed
    pendingThe issue will be closed if no feedback is provided
    on Aug 2, 2026

  12. syphyr commented on Aug 2, 2026

    @syphyr
    syphyr
    on Aug 2, 2026
    Author

    Im sorry, I should have tried to merge with 3.14 branch. My PR was closed. Here is a fixed version:

    #155098

  13. syphyr commented on Aug 2, 2026

    @syphyr
    syphyr
    on Aug 2, 2026
    Author

    Ah, I didn't notice you were running make changes (I forgot we still have that, I'm not sure we use it anywhere, out of curiosity what do you use it for?), I can reproduce it.

    I used it to build a debian package that requires the changes file.

  14. picnixz
    changed the title [-]KeyError: 'soft-deprecated'[/-] [+]KeyError: 'soft-deprecated' with `make changes`[/+] on Aug 2, 2026

  15. syphyr commented on Aug 13, 2026

    @syphyr
    syphyr
    on Aug 13, 2026
    Author

    This is fixed by #155100

  16. StanFromIreland
    added 3 commits that reference this issue on Sep 12, 2026

    gh-155095: Fix docs changes builder for our custom directives (#155100)

    94dc051

    [3.14] gh-155095: Fix docs changes builder for our custom directives (G…

    b9f6d5a

    [3.13] gh-155095: Fix docs changes builder for our custom directives (G…

    0a7db33
  17. hugovk
    added a commit that references this issue on Sep 12, 2026

    [3.15] gh-155095: Fix docs changes builder for our custom directives (G…

    6241129

  18. hugovk commented on Sep 12, 2026

    @hugovk
    hugovk
    on Sep 12, 2026
    Member

    Thanks for the report! This is now fixed.

  19. hugovk
    closed this as completedon Sep 12, 2026
  20. clin1234
    added a commit that references this issue on Sep 12, 2026

    pythongh-155095: Fix docs changes builder for our custom directives (p…

    063051a
  21. johnslavik
    added a commit that references this issue on Sep 14, 2026

    pythongh-155095: Fix docs changes builder for our custom directives (p…

    ea20c7a
  22. KingLizard1020
    added a commit that references this issue on Sep 21, 2026

    pythongh-141044: Fix Docs soft-deprecated KeyError in changes builder

    124b140
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 dirtype-bugAn unexpected behavior, bug, or error

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions