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(), no typing.get_type_hints().
Handles TYPE_CHECKING blocks 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_typehints_gp-0.1.0a37.tar.gz (52.3 kB view details)

Uploaded Jul 27, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_autodoc_typehints_gp-0.1.0a37-py3-none-any.whl (54.9 kB view details)

Uploaded Jul 27, 2026 Python 3

File details

Details for the file sphinx_autodoc_typehints_gp-0.1.0a37.tar.gz.

File metadata

Download URL: sphinx_autodoc_typehints_gp-0.1.0a37.tar.gz
Upload date: Jul 27, 2026
Size: 52.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_autodoc_typehints_gp-0.1.0a37.tar.gz
Algorithm	Hash digest
SHA256	`d80b1714d28fc7305c58655f610b0c15db0a93ce61752eeb96ae9b5b1f19e0db`
MD5	`cb1632fb17eafac3675042ab983b0cbf`
BLAKE2b-256	`83a4667e4a81d8752c0a103c8bc211859aed313cc857906134ad142ce128efb0`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_typehints_gp-0.1.0a37.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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.1.0a37.tar.gz
- Subject digest: d80b1714d28fc7305c58655f610b0c15db0a93ce61752eeb96ae9b5b1f19e0db
- Sigstore transparency entry: 2256729499
- Sigstore integration time: Jul 27, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Branch / Tag: refs/tags/v0.1.0a37
- Owner: https://github.com/git-pull
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Trigger Event: push