Add new print_traceback
configuration option
#13163
Open
+30
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow the full traceback to be printed when Sphinx encounters an internal fatal error.
Purpose
Detail
For instance, when Sphinx is run in CI/CD (like GitHub actions workflows), we do not have access to the file-system. So when Sphinx encounter a fatal internal error, it just print the last frace of the traceback and dump the full traceback in a local temporary file.
This can produce error logs as uninformative as:
So by always printing the full traceback, this PR will improve identification of root causes, especially if they're coming from third-party plugins and extensions. I expect this change to have the nice side effect of improving bug reports to the community.