Repository navigation
KeyError: 'soft-deprecated' with make changes #155095
Description
Bug report
Bug description:
The following command fails when build sphinx doc:
make -C Doc changesThe 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
- gh-155095: Add soft-deprecated to site-packages #155096
- gh-155095: Fix docs changes builder for our custom directives #155100
- [3.14] gh-155095: Fix docs changes builder for our custom directives (GH-155100) #157357
- [3.13] gh-155095: Fix docs changes builder for our custom directives (GH-155100) (GH-157357) #157358
- [3.15] gh-155095: Fix docs changes builder for our custom directives (GH-155100) #157359
Metadata
Metadata
Assignees
Projects
- Status
Activity
Add soft-deprecated to site-packages
StanFromIreland commentedon Aug 2, 2026
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?
StanFromIreland commentedon Aug 2, 2026
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.syphyr commentedon Aug 2, 2026
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-deprecatedin not defined in changes.py in site-packages.This fixes the build issue: #155096
syphyr commentedon Aug 2, 2026
Im sorry, I should have tried to merge with 3.14 branch. My PR was closed. Here is a fixed version:
#155098
syphyr commentedon Aug 2, 2026
I used it to build a debian package that requires the
changesfile.[-]KeyError: 'soft-deprecated'[/-][+]KeyError: 'soft-deprecated' with `make changes`[/+]syphyr commentedon Aug 13, 2026
This is fixed by #155100
gh-155095: Fix docs changes builder for our custom directives (#155100)
[3.14] gh-155095: Fix docs changes builder for our custom directives (G…
[3.13] gh-155095: Fix docs changes builder for our custom directives (G…
[3.15] gh-155095: Fix docs changes builder for our custom directives (G…
hugovk commentedon Sep 12, 2026
Thanks for the report! This is now fixed.
pythongh-155095: Fix docs changes builder for our custom directives (p…
pythongh-155095: Fix docs changes builder for our custom directives (p…
pythongh-141044: Fix Docs soft-deprecated KeyError in changes builder