This release is a pre-release and may not be stable for production use.
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 innerapi-*shell without becomingdescentriesbuild_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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-ux-autodoc-layout 0.1.0a39
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_ux_autodoc_layout-0.1.0a39.tar.gz | 30.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_ux_autodoc_layout-0.1.0a39-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.1 kB
Release files / sphinx_ux_autodoc_layout-0.1.0a39.tar.gz
| Download URL | sphinx_ux_autodoc_layout-0.1.0a39.tar.gz |
|---|---|
| Size | 30.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f1856fe0739c1576f3665e20b30642ccfcee3c6e76bce60572fddc843d88aa2a
|
|
BLAKE2b-256 checksum How to use checksums |
45254fbe0e13d68b1578c98d2d78d7ebc3f8853e13d3b455c31c886f04f1f6b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency logRelease files / sphinx_ux_autodoc_layout-0.1.0a39-py3-none-any.whl
| Download URL | sphinx_ux_autodoc_layout-0.1.0a39-py3-none-any.whl |
|---|---|
| Size | 35.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f83765fa74131ef1d664772557507fe02e2beea33bfa0c0d952e827d339e2cfc
|
|
BLAKE2b-256 checksum How to use checksums |
4749553c7ca76e0bbaa628151ff442b019afb110bcb756ba70ed59ddc157e4e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency log
