| Name | mkdocstrings-python-legacy JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | None |
| Summary | A legacy Python handler for mkdocstrings. |
| upload_time | 2024-09-07 15:00:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | ISC |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">mkdocstrings-python-legacy</h1>
<p align="center">The legacy Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
<p align="center">
<a href="https://github.com/mkdocstrings/python-legacy/actions?query=workflow%3Aci">
<img alt="ci" src="https://github.com/mkdocstrings/python-legacy/workflows/ci/badge.svg" />
</a>
<a href="https://mkdocstrings.github.io/python-legacy/">
<img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" />
</a>
<a href="https://pypi.org/project/mkdocstrings-python-legacy/">
<img alt="pypi version" src="https://img.shields.io/pypi/v/mkdocstrings-python-legacy.svg" />
</a>
<a href="https://gitpod.io/#https://github.com/mkdocstrings/python-legacy">
<img alt="gitpod" src="https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat" />
</a>
<a href="https://gitter.im/mkdocstrings/python-legacy">
<img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" />
</a>
</p>
---
<p align="center"><img src="logo.png"></p>
WARNING: We suggest using the new handler instead:
[mkdocstrings-python](https://mkdocstrings.github.io/python/).
## Installation
You can install this handler as a *mkdocstrings* extra:
```toml title="pyproject.toml"
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings[python-legacy]>=0.18",
]
```
You can also explicitely depend on the handler:
```toml title="pyproject.toml"
# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
"mkdocstrings-python-legacy",
]
```
## Preview
<!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead -->
## Features
- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
[pytkdocs](https://github.com/mkdocstrings/pytkdocs).
- **Support for type annotations:** pytkdocs collects your type annotations and *mkdocstrings* uses them
to display parameters types or return types.
- **Recursive documentation of Python objects:** just use the module dotted-path as identifier, and you get the full
module docs. You don't need to inject documentation for each class, function, etc.
- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will
be recognized by Griffe in modules, classes and even in `__init__` methods.
- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,
and Sphinx-style docstrings.
- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed
to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent.
*We do not support nested admonitions in docstrings!*
- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table
of Contents, which is nicely display by the Material theme. Thanks to *mkdocstrings* cross-reference ability,
you can reference other objects within your docstrings, with the classic Markdown syntax:
`[this object][package.module.object]` or directly with `[package.module.object][]`
- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code
of the Python object.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocstrings-python-legacy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
"download_url": "https://files.pythonhosted.org/packages/2a/8a/04c14190a64f29d4f85a6ceee0701a11d6899db85ffc15beb23a90437804/mkdocstrings_python_legacy-0.2.4.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">mkdocstrings-python-legacy</h1>\n\n<p align=\"center\">The legacy Python handler for <a href=\"https://github.com/mkdocstrings/mkdocstrings\"><i>mkdocstrings</i></a>.</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/mkdocstrings/python-legacy/actions?query=workflow%3Aci\">\n <img alt=\"ci\" src=\"https://github.com/mkdocstrings/python-legacy/workflows/ci/badge.svg\" />\n </a>\n <a href=\"https://mkdocstrings.github.io/python-legacy/\">\n <img alt=\"documentation\" src=\"https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat\" />\n </a>\n <a href=\"https://pypi.org/project/mkdocstrings-python-legacy/\">\n <img alt=\"pypi version\" src=\"https://img.shields.io/pypi/v/mkdocstrings-python-legacy.svg\" />\n </a>\n <a href=\"https://gitpod.io/#https://github.com/mkdocstrings/python-legacy\">\n <img alt=\"gitpod\" src=\"https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat\" />\n </a>\n <a href=\"https://gitter.im/mkdocstrings/python-legacy\">\n <img alt=\"gitter\" src=\"https://badges.gitter.im/join%20chat.svg\" />\n </a>\n</p>\n\n---\n\n<p align=\"center\"><img src=\"logo.png\"></p>\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<!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead -->\n\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",
"bugtrack_url": null,
"license": "ISC",
"summary": "A legacy Python handler for mkdocstrings.",
"version": "0.2.4",
"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"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05105bfba474535450b07423df0a7e2b467148bbe83db15c509caba5472905a5",
"md5": "2271a2185ea8a7686a26a1269fcd901e",
"sha256": "e2a05d9355500d8f596a0bfc2a5728af91300432def90bc605ed484b0052efa0"
},
"downloads": -1,
"filename": "mkdocstrings_python_legacy-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2271a2185ea8a7686a26a1269fcd901e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27568,
"upload_time": "2024-09-07T15:00:28",
"upload_time_iso_8601": "2024-09-07T15:00:28.526595Z",
"url": "https://files.pythonhosted.org/packages/05/10/5bfba474535450b07423df0a7e2b467148bbe83db15c509caba5472905a5/mkdocstrings_python_legacy-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a8a04c14190a64f29d4f85a6ceee0701a11d6899db85ffc15beb23a90437804",
"md5": "32d39ffc4726b742ee217c2412a9f489",
"sha256": "36d160ac7af5a3cec764eeb66522f42a116088a41289e04372592b91e14abbbc"
},
"downloads": -1,
"filename": "mkdocstrings_python_legacy-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "32d39ffc4726b742ee217c2412a9f489",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 97213,
"upload_time": "2024-09-07T15:00:30",
"upload_time_iso_8601": "2024-09-07T15:00:30.204053Z",
"url": "https://files.pythonhosted.org/packages/2a/8a/04c14190a64f29d4f85a6ceee0701a11d6899db85ffc15beb23a90437804/mkdocstrings_python_legacy-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 15:00:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mkdocstrings",
"github_project": "python-legacy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocstrings-python-legacy"
}
