sphinx-ux-autodoc-layout

Componentized layout for Sphinx autodoc output. It preserves Sphinx's outer dl / dt / dd structure while rebuilding managed object-description entries into stable api-* components. The current shared layout covers Python API objects, pytest fixtures, Sphinx confval entries, docutils rst:* entries, and internal FastMCP mcp:tool prototypes used to validate future consolidation work.

The extension keeps header composition in a late doctree-resolved pass so badges, source links, and permalinks can be positioned independently without raw HTML mutation. Large signatures can fold into native multiline signature markup, and expanded folded signatures show annotations by default via api_signature_show_annotations.

For shared consumers, the public helper surface now includes:

build_api_card_entry() for section-card consumers that need the same inner api-* shell without becoming desc entries
build_api_summary_section() for summary/index wrappers such as config and fixture tables

Install

$ pip install sphinx-ux-autodoc-layout

Usage

Standalone Sphinx project:

extensions = ["sphinx.ext.autodoc", "sphinx_ux_autodoc_layout"]
api_layout_enabled = True

With gp-sphinx:

conf = merge_sphinx_config(
    ...,
    extra_extensions=["sphinx_ux_autodoc_layout"],
    api_layout_enabled=True,
)

Documentation

See the full documentation for configuration reference, CSS classes, and live demos.

Download files

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

Source Distribution

sphinx_ux_autodoc_layout-0.0.1a36.tar.gz (30.8 kB view details)

Uploaded Jul 26, 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_ux_autodoc_layout-0.0.1a36-py3-none-any.whl (35.2 kB view details)

Uploaded Jul 26, 2026 Python 3

File details

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

File metadata

Download URL: sphinx_ux_autodoc_layout-0.0.1a36.tar.gz
Upload date: Jul 26, 2026
Size: 30.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_ux_autodoc_layout-0.0.1a36.tar.gz
Algorithm	Hash digest
SHA256	`5994dc3d46ba99d7b586b2b69caf174c1d8d55b5be8fa63c8106efdbf043d597`
MD5	`ca6b58ae6482498a60fa87b54555d274`
BLAKE2b-256	`3469f462a0c8a9b7599da5bb10c0f449f052843e8b55417b7cc60354bf8592a7`

See more details on using hashes here.

Provenance

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_ux_autodoc_layout-0.0.1a36.tar.gz
- Subject digest: 5994dc3d46ba99d7b586b2b69caf174c1d8d55b5be8fa63c8106efdbf043d597
- Sigstore transparency entry: 2255932310
- Sigstore integration time: Jul 26, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Branch / Tag: refs/tags/v0.0.1a36
- 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@5f287dfe1d7e138f75a9f2622be5a287a868f5b5
- Trigger Event: push