This release is a pre-release and may not be stable for production use.
sphinx-autodoc-typehints-gp
Single-package replacement for sphinx-autodoc-typehints and
sphinx.ext.napoleon — resolves annotations statically at build time,
no monkey-patching required.
Part of the gp-sphinx shared
autodoc stack: annotation normalization, cross-referenced type links, and
TYPE_CHECKING-safe resolution all live here.
Install
$ pip install sphinx-autodoc-typehints-gp
Usage
extensions = ["sphinx.ext.autodoc", "sphinx_autodoc_typehints_gp"]
# Required: makes autodoc insert type annotations into parameter descriptions.
# Without this, the type cross-referencing pipeline fires but has nothing to attach to.
autodoc_typehints = "description"
Features
- Resolves type hints statically via AST — no
exec(), notyping.get_type_hints(). - Handles
TYPE_CHECKINGblocks correctly (import-time guards are not evaluated). - No text-processing races with
sphinx.ext.napoleon. - Shared annotation normalization and rendering helpers for the
sphinx-autodoc-*family.
Documentation
See the full documentation for the API reference, helper functions, and the static resolution comparison table.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_autodoc_typehints_gp-0.0.1a35.tar.gz.
File metadata
- Download URL: sphinx_autodoc_typehints_gp-0.0.1a35.tar.gz
- Upload date:
- Size: 36.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
38897bb5d3cb1d356cd86283594bf67853df279260493a3860e043c6eaf4cf65
|
|
| MD5 |
4a75d7f6e6c16c54f75b947f20cbd5cf
|
|
| BLAKE2b-256 |
8b6ef9341eb41928e4512f011b480cc40db51f10718b8458981e7d774b8d7166
|
Provenance
The following attestation bundles were made for sphinx_autodoc_typehints_gp-0.0.1a35.tar.gz:
Publisher:
release.yml on git-pull/gp-sphinx
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_autodoc_typehints_gp-0.0.1a35.tar.gz -
Subject digest:
38897bb5d3cb1d356cd86283594bf67853df279260493a3860e043c6eaf4cf65 - Sigstore transparency entry: 2203737481
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@40bedaef923ce160b2e49ca4add8d5955902f01f -
Branch / Tag:
refs/tags/v0.0.1a35 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@40bedaef923ce160b2e49ca4add8d5955902f01f -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_autodoc_typehints_gp-0.0.1a35-py3-none-any.whl.
File metadata
- Download URL: sphinx_autodoc_typehints_gp-0.0.1a35-py3-none-any.whl
- Upload date:
- Size: 39.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fdbd3e3e63c6690f8e0a56abc167e6c74964b5e30a0ee6fbdf931a3aee7ac6ba
|
|
| MD5 |
354b3919e3efdc45714d692029bbfaa6
|
|
| BLAKE2b-256 |
a3e478eab0d6113aa6c6051efa0bb19fde3e16f76722ad765bfe1a80e69bf1e8
|
Provenance
The following attestation bundles were made for sphinx_autodoc_typehints_gp-0.0.1a35-py3-none-any.whl:
Publisher:
release.yml on git-pull/gp-sphinx
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_autodoc_typehints_gp-0.0.1a35-py3-none-any.whl -
Subject digest:
fdbd3e3e63c6690f8e0a56abc167e6c74964b5e30a0ee6fbdf931a3aee7ac6ba - Sigstore transparency entry: 2203737756
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@40bedaef923ce160b2e49ca4add8d5955902f01f -
Branch / Tag:
refs/tags/v0.0.1a35 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@40bedaef923ce160b2e49ca4add8d5955902f01f -
Trigger Event:
push
-
Statement type:
