{"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 :: Utilities","Typing :: Typed"],"description":"

mkdocstrings-python-legacy

\n\n

The legacy Python handler for mkdocstrings.

\n\n

\n \n $\"ci\"$ \n \n \n $\"documentation\"$ \n \n \n $\"pypi$ \n \n \n $\"gitpod\"$ \n \n \n $\"gitter\"$ \n \n

\n\n---\n\n

\n\nWARNING: We suggest using the new handler instead:\n[mkdocstrings-python](https://mkdocstrings.github.io/python/).\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-legacy]>=0.18\",\n]\n```\n\nYou can also explicitely 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-legacy\",\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 [pytkdocs](https://github.com/mkdocstrings/pytkdocs).\n\n- **Support for type annotations:** pytkdocs collects your type annotations and *mkdocstrings* uses them\n to display parameters types or return types.\n\n- **Recursive documentation of Python objects:** just use the module dotted-path as 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.\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 display 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-legacy","package_url":"https://pypi.org/project/mkdocstrings-python-legacy/","platform":null,"project_url":"https://pypi.org/project/mkdocstrings-python-legacy/","project_urls":{"Changelog":"https://mkdocstrings.github.io/python-legacy/changelog","Discussions":"https://github.com/mkdocstrings/python-legacy/discussions","Documentation":"https://mkdocstrings.github.io/python-legacy","Funding":"https://github.com/sponsors/pawamoy","Gitter":"https://gitter.im/mkdocstrings/python-legacy","Homepage":"https://mkdocstrings.github.io/python-legacy","Issues":"https://github.com/mkdocstrings/python-legacy/issues","Repository":"https://github.com/mkdocstrings/python-legacy"},"provides_extra":null,"release_url":"https://pypi.org/project/mkdocstrings-python-legacy/0.2.7/","requires_dist":["mkdocstrings>=0.28.3","mkdocs-autorefs>=1.1","pytkdocs>=0.14"],"requires_python":">=3.9","summary":"A legacy Python handler for mkdocstrings.","version":"0.2.7","yanked":false,"yanked_reason":null}

Dependencies of mkdocstrings-python-legacy (3).
Dependency	Optional
mkdocs-autorefs	false
mkdocstrings	false
pytkdocs	false

Package search

mkdocstrings-python-legacy

project_urls

Dependencies

All package metadata

Releases