Sphinx Autodoc Integration Helper

Build a lightweight Sphinx extension that wires in the dependency so NumPy-style docstrings are transformed automatically and its specialized directive domains are available during documentation builds.

Capabilities

Autodoc docstring processing

• When the helper attaches to a Sphinx app and autodoc processes a function with NumPy-style Parameters/Returns sections, the generated reStructuredText shows those sections rendered as field lists instead of raw prose. @test

Signature normalization

• When a callable lacks an inspectable signature but documents one in its docstring, autodoc emits the documented parameters as the call signature. @test

Custom domains available

• After configuration, the Sphinx app registers the dependency's Python and C directive domains and they can be used to resolve roles in a sample document. @test

Member inclusion defaults

• Configuration sets sensible defaults for showing class members and inherited members so that autodoc output includes attributes listed in a class docstring. @test

Implementation

@generates

API

def configure_autodoc(app) -> None:
    """Attach the dependency's autodoc processing, configure member visibility, and ensure its custom domains are active."""

Dependencies { .dependencies }

numpydoc { .dependency }

Provides NumPy-style autodoc hooks and custom domains for Sphinx.