Skip to content

fix(ext.autodoc): fix logging of tracebacks #13944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix(ext.autodoc): fix logging of tracebacks #13944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
010b678
fix(ext.autodoc): fix logging of tracebacks
spaceone Oct 10, 2025
b228e72
chore(AUTHORS): add myself to authors
spaceone Oct 13, 2025
b9593b2
chore(CHANGES): add changelog entry
spaceone Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Contributors
* Etienne Desautels -- apidoc module
* Ezio Melotti -- collapsible sidebar JavaScript
* Filip Vavera -- napoleon todo directive
* Florian Best -- log improvements
* Glenn Matthews -- python domain signature improvements
* Gregory Szorc -- performance improvements
* Henrique Bastos -- SVG support for graphviz extension
Expand Down
2 changes: 2 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ Bugs fixed
directly defined in certain cases, depending on autodoc processing
order.
Patch by Jeremy Maitin-Shepard.
* #13944: autodoc: show traceback during import in human readable representation.
Patch by Florian Best.


Testing
Expand Down
2 changes: 1 addition & 1 deletion sphinx/ext/autodoc/importer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def _import_from_module_and_path(
# import_module() raises ImportError having real exception obj and
# traceback
real_exc = exc.args[0]
traceback_msg = traceback.format_exception(exc)
traceback_msg = ''.join(traceback.format_exception(exc))
if isinstance(real_exc, SystemExit):
err_parts.append(
'the module executes module level statement '
Expand Down
Loading