Overview:

The Python handler Griffe is a documentation tool that extracts information from Python source code. It can navigate the Abstract Syntax Tree (AST) of the code, execute code when source is unavailable, and parse docstrings in various styles. The tool provides support for type annotations, recursive documentation of Python objects, documented attributes, multiple docstring styles, admonition support, TOC entries for each object, and source code display.

Features:

Data collection from source code: Extracts the object-tree and docstrings using Griffe.
Support for type annotations: Collects type annotations for parameter and return types, and adds cross-references.
Recursive documentation of Python objects: Enables full module documentation using module dotted-path identifiers.
Support for documented attributes: Recognizes attributes with docstrings in modules, classes, and methods.
Multiple docstring-styles support: Includes Google-style, Numpydoc-style, and Sphinx-style docstrings.
Admonition support in Google docstrings: Transforms Note: or Warning: blocks to admonition equivalents.
TOC entry for every object: Renders a heading for each object for easy navigation in the Table of Contents.
Source code display: Provides a collapsible div with highlighted source code for Python objects.

Summary:

Griffe is a versatile Python handler that simplifies the process of generating documentation from source code. With features like type annotation support, recursive object documentation, multiple docstring styles, and source code display, Griffe enhances the documentation workflow for Python developers. The tool's ability to extract information from code, even when the source is not available, makes it a valuable asset for documenting Python projects efficiently.

Mkdocstrings

Autorefs

Crystal

Mkdocstrings

Python