Release notes

These notes track the autodoc-py generator, independently of Dockit and of the Python package being documented. The tab badge shows the generator version pinned by the documentation workspace.

0.2.0a1 — September 7, 2026

• Configure topic pages with --page-map instead of exposing every source module in the sidebar.
• Add page introductions, linked API indexes, and namespaced module/symbol anchors.
• Keep methods within their class sections and collapse repeated function overload headings.
• Document public callable singletons, including EnvVar and piter, without importing source.
• Format Google-style arguments, returns, and indented Python examples for MDX.
• Harden Markdown fences and MDX escaping; support Python source encoding declarations.
• Add README, license metadata, and public project links to built distributions.

The first PyPI prerelease.

• Typeset signatures with linked local annotations, positional and keyword-only markers, and defaults.
• Present parameter, return, exception, and attribute documentation in structured sections.
• Include type aliases, NamedTuple fields, properties, async methods, and class bases.
• Bundle the reference stylesheet with the Python package.

See the Python API display for a rendered example. Validated against params-proto and all 11 modules in Vuer v0.0.29-rc11, including MDX compilation and internal links.

0.1.0 — initial source version

The existing v0.1.0 tag points to source revision 247f6ba. This initial version was distributed from Git; it was not published to PyPI.

Included

• Parse Python source without importing the documented package or installing its dependencies.
• Generate Dockit MDX pages for modules, public classes and functions, constructors, methods, and class attributes.
• Include signatures, docstrings, source links, and navigation frontmatter.
• Link local explicit and star re-exports and inherited members; suppress overridden member names.
• Honor literal __all__ for locally defined public classes and functions.
• Generate API links that work with or without trailing slashes.
• Track generated files in a manifest so removed modules are cleaned up without deleting hand-written pages.
• Parse all input Python files before modifying output.

Compatibility and limits

Python 3.10 or later is required. There are no runtime dependencies. The source compatibility audit covered all 149 historical Vuer tags, including tassa/, vuer/, and src/vuer/ package layouts. It checked generation and internal links, not runtime behavior or MDX compilation. See the validation report.

Dynamic members, external inheritance and re-exports, full Python C3 method resolution, and Sphinx directive execution remain outside the generator's scope. See static analysis boundaries.

Install this revision

The distribution name is dreamlake-autodoc-py; the executable is autodoc-py. Install the prerelease with uv:

uv tool install 'dreamlake-autodoc-py==0.2.0a1'
autodoc-py --help

The same package requirement works with python -m pip install. See Generate API docs for command options and build integration.