{"id":15447306,"url":"https://github.com/mkdocstrings/python-legacy","last_synced_at":"2025-04-19T21:30:29.689Z","repository":{"id":43755603,"uuid":"439472539","full_name":"mkdocstrings/python-legacy","owner":"mkdocstrings","description":"A legacy Python handler for mkdocstrings.","archived":false,"fork":false,"pushed_at":"2023-12-06T10:36:17.000Z","size":1106,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-23T10:45:31.301Z","etag":null,"topics":["autodoc","documentation","mkdocs","mkdocstrings","mkdocstrings-handler","python","python-documentation"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/python-legacy","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pawamoy","ko_fi":"pawamoy","custom":["https://www.paypal.me/pawamoy"]}},"created_at":"2021-12-17T22:11:34.000Z","updated_at":"2024-06-20T23:21:48.348Z","dependencies_parsed_at":"2024-06-20T23:21:44.879Z","dependency_job_id":"fe6c7681-2baf-479b-9195-a1b26ccb9143","html_url":"https://github.com/mkdocstrings/python-legacy","commit_stats":{"total_commits":41,"total_committers":2,"mean_commits":20.5,"dds":"0.024390243902439046","last_synced_commit":"9c5c653733fc55d638b831ec6845c1eea9491d38"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython-legacy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython-legacy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython-legacy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython-legacy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/python-legacy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249810065,"owners_count":21328533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autodoc","documentation","mkdocs","mkdocstrings","mkdocstrings-handler","python","python-documentation"],"created_at":"2024-10-01T20:04:46.658Z","updated_at":"2025-04-19T21:30:29.672Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","readme":"\u003ch1 align=\"center\"\u003emkdocstrings-python-legacy\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eThe legacy Python handler for \u003ca href=\"https://github.com/mkdocstrings/mkdocstrings\"\u003e\u003ci\u003emkdocstrings\u003c/i\u003e\u003c/a\u003e.\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/mkdocstrings/python-legacy/actions?query=workflow%3Aci\"\u003e\n    \u003cimg alt=\"ci\" src=\"https://github.com/mkdocstrings/python-legacy/workflows/ci/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://mkdocstrings.github.io/python-legacy/\"\u003e\n    \u003cimg alt=\"documentation\" src=\"https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocstrings-python-legacy/\"\u003e\n    \u003cimg alt=\"pypi version\" src=\"https://img.shields.io/pypi/v/mkdocstrings-python-legacy.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitpod.io/#https://github.com/mkdocstrings/python-legacy\"\u003e\n    \u003cimg alt=\"gitpod\" src=\"https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitter.im/mkdocstrings/python-legacy\"\u003e\n    \u003cimg alt=\"gitter\" src=\"https://badges.gitter.im/join%20chat.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"logo.png\"\u003e\u003c/p\u003e\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]\u003e=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\u003c!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead --\u003e\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","funding_links":["https://github.com/sponsors/pawamoy","https://ko-fi.com/pawamoy","https://www.paypal.me/pawamoy"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fpython-legacy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fpython-legacy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fpython-legacy/lists"}