{"author":null,"author_email":"=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.14","Programming Language :: Python :: 3.9","Topic :: Documentation","Topic :: Software Development","Topic :: Software Development :: Documentation","Topic :: Utilities","Typing :: Typed"],"description":"

mkdocstrings-python

\n\n

A Python handler for mkdocstrings.

\n\n[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)\n\n---\n\n

\n\nThe Python handler uses [Griffe](https://mkdocstrings.github.io/griffe)\nto collect documentation from Python source code.\nThe word \"griffe\" can sometimes be used instead of \"signature\" in French.\nGriffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information.\nIt is also able to execute the code (by importing it) and introspect objects in memory\nwhen source code is not available. Finally, it can parse docstrings following different styles.\n\n## Installation\n\nYou can install this handler as a *mkdocstrings* extra:\n\n```toml title=\"pyproject.toml\"\n# PEP 621 dependencies declaration\n# adapt to your dependencies manager\n[project]\ndependencies = [\n \"mkdocstrings[python]>=0.18\",\n]\n```\n\nYou can also explicitly depend on the handler:\n\n```toml title=\"pyproject.toml\"\n# PEP 621 dependencies declaration\n# adapt to your dependencies manager\n[project]\ndependencies = [\n \"mkdocstrings-python\",\n]\n```\n\n## Preview\n\n\n![mkdocstrings_python_gif](https://user-images.githubusercontent.com/3999221/77157838-7184db80-6aa2-11ea-9f9a-fe77405202de.gif)\n\n## Features\n\n- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to\n [Griffe](https://github.com/mkdocstrings/griffe).\n\n- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them\n to display parameter types or return types. It is even able to automatically add cross-references\n to other objects from your API, from the standard library or third-party libraries!\n See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it.\n\n- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full\n module docs. You don't need to inject documentation for each class, function, etc.\n\n- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will\n be recognized by Griffe in modules, classes and even in `__init__` methods.\n\n- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,\n and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support.\n\n- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed\n to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent.\n *We do not support nested admonitions in docstrings!*\n\n- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table\n of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability,\n you can reference other objects within your docstrings, with the classic Markdown syntax:\n `[this object][package.module.object]` or directly with `[package.module.object][]`\n\n- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code\n of the Python object.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":"ISC","license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"mkdocstrings-python","package_url":"https://pypi.org/project/mkdocstrings-python/","platform":null,"project_url":"https://pypi.org/project/mkdocstrings-python/","project_urls":{"Changelog":"https://mkdocstrings.github.io/python/changelog","Discussions":"https://github.com/mkdocstrings/python/discussions","Documentation":"https://mkdocstrings.github.io/python","Funding":"https://github.com/sponsors/pawamoy","Gitter":"https://gitter.im/mkdocstrings/python","Homepage":"https://mkdocstrings.github.io/python","Issues":"https://github.com/mkdocstrings/python/issues","Repository":"https://github.com/mkdocstrings/python"},"provides_extra":null,"release_url":"https://pypi.org/project/mkdocstrings-python/1.16.10/","requires_dist":["mkdocstrings>=0.28.3","mkdocs-autorefs>=1.4","griffe>=1.6.2","typing-extensions>=4.0; python_version < \"3.11\""],"requires_python":">=3.9","summary":"A Python handler for mkdocstrings.","version":"1.16.10","yanked":false,"yanked_reason":null}

Dependency	Optional
griffe	false
mkdocs-autorefs	false
mkdocstrings	false
typing-extensions	false

Package search

mkdocstrings-python

project_urls

Dependencies

All package metadata

Releases