Skip to main content
Pre-release

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(), 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.0.1a36.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

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

sphinx_autodoc_typehints_gp-0.0.1a36-py3-none-any.whl (46.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autodoc_typehints_gp-0.0.1a36.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_typehints_gp-0.0.1a36.tar.gz
Algorithm Hash digest
SHA256 7db185c4f6be1e0c8055d3d9b685f68c3ea0823badd6a546a842ea11f12526de
MD5 f116ff7e3b54d7fb612542ba5cca8d37
BLAKE2b-256 c2b2a915b9405b63a00261caa039deaa10e45b6f4edd301094844cd6c695901a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_typehints_gp-0.0.1a36.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.

File details

Details for the file sphinx_autodoc_typehints_gp-0.0.1a36-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_typehints_gp-0.0.1a36-py3-none-any.whl
Algorithm Hash digest
SHA256 1bfa9d936ddbf36076e9d4c284e22270aca31866ec3ba838783cb4fca69753bf
MD5 e8182f5a4cd0b4e7761dbed282f316ba
BLAKE2b-256 c634b020e1acf7884f5ea275e172f0beee0425e7a49c65f4e061da33f12226a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_typehints_gp-0.0.1a36-py3-none-any.whl:

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.

Release history Release notifications | RSS feed

This release

0.0.1a36 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page