Feeding a clanker? Grab this page as raw .md →

ApiDoc API#

ApiDoc takes a Python class or function and renders what inspect can see about it — the signature, a parameter table with types and defaults, the docstring, and any methods and properties — as a formatted card in the notebook, without a docs build in the loop. Useful when you are teaching a library in a notebook and want the reference sitting next to the example instead of in another tab; show_private decides whether underscore-prefixed methods show up.

See also: ModuleTreeWidget for inspecting a PyTorch module's structure, LiveEdit for showing what a function actually does when it runs, and CellTour for walking a reader through the notebook around it.

Bases: AnyWidget

Renders API documentation for a Python class or function in a notebook.

Examples:

import marimo as mo
from wigglystuff import ApiDoc

mo.ui.anywidget(ApiDoc(MyClass))

Create an ApiDoc widget.

Parameters:

Name	Type	Description	Default
`obj`	`Any`	A Python class or function to document.	`None`
`width`	`int`	Maximum pixel width for the widget.	`700`
`show_private`	`bool`	Whether to include _-prefixed methods.	`False`

Source code in wigglystuff/api_doc.py

def __init__(self, obj: Any = None, *, width: int = 700, show_private: bool = False):
    """Create an ApiDoc widget.

    Args:
        obj: A Python class or function to document.
        width: Maximum pixel width for the widget.
        show_private: Whether to include _-prefixed methods.
    """
    self._obj = obj
    super().__init__(width=width, show_private=show_private)
    if obj is not None:
        self.doc = _extract_doc(obj, show_private)

to_markdown #

to_markdown() -> str

Export the API documentation as a Markdown string.

Source code in wigglystuff/api_doc.py

def to_markdown(self) -> str:
    """Export the API documentation as a Markdown string."""
    doc = self.doc
    if not doc or not doc.get("name"):
        return ""

    parts = []

    # Title
    prefix = f"{doc['module']}." if doc.get("module") else ""
    parts.append(f"## `{prefix}{doc['name']}`")
    parts.append(f"\n> {doc.get('kind', 'class')}")

    # Signature
    if doc.get("signature"):
        parts.append(f"\n```python\n{doc['name']}{doc['signature']}\n```")

    # Bases
    if doc.get("bases"):
        bases = ", ".join(f"`{b}`" for b in doc["bases"])
        parts.append(f"\nBases: {bases}")

    # Docstring
    if doc.get("docstring"):
        parts.append(f"\n{doc['docstring']}")

    # Parameter table
    params = doc.get("parameters", [])
    if params:
        parts.append("\n| Name | Type | Default |")
        parts.append("| --- | --- | --- |")
        for p in params:
            name = f"`{p['name']}`"
            ann = f"`{p['annotation']}`" if p.get("annotation") else ""
            default = f"`{p['default']}`" if p.get("default") else ""
            parts.append(f"| {name} | {ann} | {default} |")

    # Methods
    methods = doc.get("methods", [])
    if methods:
        parts.append("\n### Methods")
        for m in methods:
            sig = m.get("signature", "()")
            decorator = f" *{m['decorator']}*" if m.get("decorator") else ""
            parts.append(f"\n#### `{m['name']}{sig}`{decorator}")
            if m.get("docstring"):
                parts.append(f"\n{m['docstring']}")

    # Properties
    props = doc.get("properties", [])
    if props:
        parts.append("\n### Properties")
        for p in props:
            parts.append(f"\n#### `{p['name']}` *property*")
            if p.get("docstring"):
                parts.append(f"\n{p['docstring']}")

    return "\n".join(parts)

Synced traitlets#

Traitlet	Type	Notes
`doc`	`dict`	Introspected documentation payload (auto-generated from the target object).
`width`	`int`	Container width in pixels.
`show_private`	`bool`	Whether to include private (underscore-prefixed) methods.