Python
A Python handler for mkdocstrings.
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.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
