Skip to content

Releases: emcd/python-dynadoc

v1.4

29 Jul 05:19
v1.4
c51d13d

Choose a tag to compare

Dynadoc v1.4 (2025-07-29)

Enhancements

  • Add exclude decorator to prevent other Dynadoc processing of the object.
    Does not actually decorate the object in any way, but adds it to Dynadoc's
    visitees registry, which will cause the Dyandoc decorators to short-circuit on
    the object.

v1.3

13 Jul 01:35
v1.3
7ae1f66

Choose a tag to compare

Dynadoc v1.3 (2025-07-13)

Enhancements

  • Improve handling of stringified type annotations and forward references.

v1.2.1

05 Jun 22:05
v1.2.1
2fe4af6

Choose a tag to compare

Dynadoc v1.2.1 (2025-06-05)

Repairs

  • Only collect documentation fragments attribute from class and not its ancestors
    or metaclass.

v1.2

02 Jun 23:52
v1.2
7a15845

Choose a tag to compare

Dynadoc v1.2 (2025-06-02)

Enhancements

  • Allow introspection limits to completely disable introspection. Useful when a
    limiter function detects a marker attribute, which indicates complete
    documentation or immutability, on a class or module.

Repairs

  • Always sever type-adjacent information, when transiting nested annotations, to
    prevent ambiguity problems and unexpected information accumulation.

v1.2rc0

02 Jun 23:40
v1.2rc0
c16af85

Choose a tag to compare

Dynadoc v1.2rc0 (2025-06-02)

Enhancements

  • Allow introspection limits to completely disable introspection. Useful when a
    limiter function detects a marker attribute, which indicates complete
    documentation or immutability, on a class or module.

Repairs

  • Always sever type-adjacent information, when transiting nested annotations, to
    prevent ambiguity problems and unexpected information accumulation.

v1.1

30 May 03:37
v1.1
e401c16

Choose a tag to compare

Dynadoc v1.1 (2025-05-30)

Enhancements

  • Improve argument and return documentation on Sphinx Autodoc renderer.

Repairs

  • Ensure multiline descriptions render correctly by indenting all subsequent
    lines after the first one.

v1.1rc0

30 May 03:11
v1.1rc0
a3177e2

Choose a tag to compare

Dynadoc v1.1rc0 (2025-05-30)

Enhancements

  • Improve argument and return documentation on Sphinx Autodoc renderer.

Repairs

  • Ensure multiline descriptions render correctly by indenting all subsequent
    lines after the first one.

v1.0

25 May 22:32
v1.0
4c4a0be

Choose a tag to compare

Dynadoc v1.0 (2025-05-25)

Enhancements

  • Add support for CPython 3.10, 3.11, 3.12, and 3.13.
  • Add support for PyPy 3.10.
  • Automatic docstring generation from Doc and Raises annotations.
    Extracts rich documentation metadata from type annotations and generates
    comprehensive Sphinx-compatible docstrings.
  • Configurable introspection with recursive documentation of classes, functions,
    properties, and modules. Fine-grained control over documentation depth,
    inheritance processing, and attribute scanning.
  • Extensible architecture with custom renderers, fragment rectifiers, and
    introspection limiters. Configurable contexts and error handling strategies
    for different development workflows and deployment environments.
  • Flexible visibility control system with support for __all__ declarations,
    custom visibility deciders, and explicit Visibilities annotations.
    Controls which attributes appear in generated documentation.
  • Function and class decoration with @with_docstring decorator. Processes
    annotated parameters, return values, and exception specifications to generate
    detailed reStructuredText documentation.
  • Module-level documentation generation with assign_module_docstring.
    Automatically documents module attributes, type aliases, and exported
    functions with comprehensive introspection capabilities.
  • Reusable documentation fragment system with Fname annotations. Enables
    consistent terminology across projects through fragment tables and
    class-based fragment storage via _dynadoc_fragments_ attributes.
  • Sphinx Autodoc-compatible reStructuredText renderer with multiple formatting
    styles. Generates proper :argument:, :type:, :returns:, and
    :raises: directives for seamless integration with Sphinx documentation.

v1.0rc0

25 May 21:05
v1.0rc0
b27394c

Choose a tag to compare

Dynadoc v1.0rc0 (2025-05-25)

Enhancements

  • Add support for CPython 3.10, 3.11, 3.12, and 3.13.
  • Add support for PyPy 3.10.
  • Automatic docstring generation from Doc and Raises annotations.
    Extracts rich documentation metadata from type annotations and generates
    comprehensive Sphinx-compatible docstrings.
  • Configurable introspection with recursive documentation of classes, functions,
    properties, and modules. Fine-grained control over documentation depth,
    inheritance processing, and attribute scanning.
  • Extensible architecture with custom renderers, fragment rectifiers, and
    introspection limiters. Configurable contexts and error handling strategies
    for different development workflows and deployment environments.
  • Flexible visibility control system with support for __all__ declarations,
    custom visibility deciders, and explicit Visibilities annotations.
    Controls which attributes appear in generated documentation.
  • Function and class decoration with @with_docstring decorator. Processes
    annotated parameters, return values, and exception specifications to generate
    detailed reStructuredText documentation.
  • Module-level documentation generation with assign_module_docstring.
    Automatically documents module attributes, type aliases, and exported
    functions with comprehensive introspection capabilities.
  • Reusable documentation fragment system with Fname annotations. Enables
    consistent terminology across projects through fragment tables and
    class-based fragment storage via _dynadoc_fragments_ attributes.
  • Sphinx Autodoc-compatible reStructuredText renderer with multiple formatting
    styles. Generates proper :argument:, :type:, :returns:, and
    :raises: directives for seamless integration with Sphinx documentation.