Skip to content

Show version in error tracebacks #554

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.

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 1 commit into
base: main
Choose a base branch
from

Conversation

kdeldycke
Copy link

Add the extension version to the plugin metadata so Sphinx can report it on traceback.

Without it, sphinx-autodoc-typehints is reported with an unknown version. See for example:

Versions
========

* Platform:         darwin; (macOS-15.5-arm64-64bit)
* Python version:   3.11.11 (CPython)
* Sphinx version:   8.2.3
* Docutils version: 0.21.2
* Jinja2 version:   3.1.6
* Pygments version: 2.19.2

Last Messages
=============

(...)

Loaded Extensions
=================

* sphinx.ext.mathjax (8.2.3)
* alabaster (1.0.0)
* sphinxcontrib.applehelp (2.0.0)
* sphinxcontrib.devhelp (2.0.0)
* sphinxcontrib.htmlhelp (2.1.0)
* sphinxcontrib.serializinghtml (2.0.0)
* sphinxcontrib.qthelp (2.0.0)
* sphinx.ext.autodoc.preserve_defaults (8.2.3)
* sphinx.ext.autodoc.type_comment (8.2.3)
* sphinx.ext.autodoc.typehints (8.2.3)
* sphinx.ext.autodoc (8.2.3)
* sphinx.ext.todo (8.2.3)
* sphinx.ext.intersphinx (8.2.3)
* sphinx.ext.viewcode (8.2.3)
* sphinx_copybutton (0.5.2)
* sphinx_design (0.6.1)
* sphinx_issues (5.0.1)
* sphinxext.opengraph (0.10.0)
* myst_parser (4.0.1)
* sphinx.ext.autosectionlabel (8.2.3)
* sphinx_autodoc_typehints (unknown version)
* click_extra.sphinx (5.1.0)
* sphinxcontrib.mermaid (8.2.3)
* furo (2025.07.19)
* sphinx_basic_ng (1.0.0.beta2)

Traceback
=========

(...)

hoodmane
hoodmane previously approved these changes Jul 28, 2025
Copy link
Collaborator

@hoodmane hoodmane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@hoodmane hoodmane enabled auto-merge (squash) July 28, 2025 08:45
auto-merge was automatically disabled July 28, 2025 10:13

Head branch was pushed to by a user without write access

@hoodmane hoodmane enabled auto-merge (squash) July 28, 2025 10:31
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add please a test to validate this behaviour happens?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants