mkdocstrings-python 1.18.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

mkdocstrings_handlers/python/templates/material/children.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/children.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/admonition.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/admonition.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/attributes.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/attributes.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/classes.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/classes.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/examples.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/examples.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/functions.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/functions.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/modules.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/modules.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/other_parameters.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/parameters.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/parameters.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/raises.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/raises.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/receives.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/receives.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/returns.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/returns.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/warns.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/warns.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring/yields.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/yields.html.jinja" %}

mkdocstrings_handlers/python/templates/material/docstring.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring.html.jinja" %}

mkdocstrings_handlers/python/templates/material/expression.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/expression.html.jinja" %}

mkdocstrings_handlers/python/templates/material/function.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/function.html.jinja" %}

mkdocstrings_handlers/python/templates/material/labels.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/labels.html.jinja" %}

mkdocstrings_handlers/python/templates/material/language.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/language.html.jinja" %}

mkdocstrings_handlers/python/templates/material/languages/en.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/en.html.jinja" %}

mkdocstrings_handlers/python/templates/material/languages/ja.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/ja.html.jinja" %}

mkdocstrings_handlers/python/templates/material/languages/zh.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/zh.html.jinja" %}

mkdocstrings_handlers/python/templates/material/module.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/module.html.jinja" %}

mkdocstrings_handlers/python/templates/material/signature.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/signature.html.jinja" %}

mkdocstrings_handlers/python/templates/material/summary/attributes.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/summary/attributes.html.jinja" %}

mkdocstrings_handlers/python/templates/material/summary/classes.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/summary/classes.html.jinja" %}

mkdocstrings_handlers/python/templates/material/summary/functions.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/summary/functions.html.jinja" %}

mkdocstrings_handlers/python/templates/material/summary/modules.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/summary/modules.html.jinja" %}

mkdocstrings_handlers/python/templates/material/summary.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/summary.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/attributes.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/attributes.html' is deprecated, extend '_base/docstring/attributes.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/other_parameters.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/other_parameters.html' is deprecated, extend '_base/docstring/other_parameters.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/parameters.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/parameters.html' is deprecated, extend '_base/docstring/parameters.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/raises.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/raises.html' is deprecated, extend '_base/docstring/raises.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/receives.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/receives.html' is deprecated, extend '_base/docstring/receives.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/returns.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/returns.html' is deprecated, extend '_base/docstring/returns.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/warns.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/warns.html' is deprecated, extend '_base/docstring/warns.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/yields.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/docstring/yields.html' is deprecated, extend '_base/docstring/yields.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/language.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/language.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/language.html' is deprecated, extend '_base/language.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/en.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/languages/en.html' is deprecated, extend '_base/languages/en.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/ja.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/languages/ja.html' is deprecated, extend '_base/languages/ja.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html

@@ -1,10 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/zh.html.jinja" %}
-
-{% block logs scoped %}
-  {{ super() }}
-  {{ log.warning(
-        "DeprecationWarning: Extending '_base/languages/zh.html' is deprecated, extend '_base/languages/zh.html.jinja' instead. ",
-        once=True,
-      ) }}
-{% endblock logs %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/attributes.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/other_parameters.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/parameters.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/raises.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/receives.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/returns.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/warns.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/docstring/yields.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/language.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/language.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/languages/en.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/en.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/ja.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html

@@ -1,2 +0,0 @@
-{# YORE: Bump 2: Remove file. #}
-{% extends "_base/languages/zh.html.jinja" %}

mkdocstrings_python-1.18.2.dist-info/METADATA

@@ -1,117 +0,0 @@
-Metadata-Version: 2.4
-Name: mkdocstrings-python
-Version: 1.18.2
-Summary: A Python handler for mkdocstrings.
-Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
-License-Expression: ISC
-License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Utilities
-Classifier: Typing :: Typed
-Project-URL: Homepage, https://mkdocstrings.github.io/python
-Project-URL: Documentation, https://mkdocstrings.github.io/python
-Project-URL: Changelog, https://mkdocstrings.github.io/python/changelog
-Project-URL: Repository, https://github.com/mkdocstrings/python
-Project-URL: Issues, https://github.com/mkdocstrings/python/issues
-Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
-Project-URL: Gitter, https://gitter.im/mkdocstrings/python
-Project-URL: Funding, https://github.com/sponsors/pawamoy
-Requires-Python: >=3.9
-Requires-Dist: mkdocstrings>=0.30
-Requires-Dist: mkdocs-autorefs>=1.4
-Requires-Dist: griffe>=1.13
-Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
-Description-Content-Type: text/markdown
-
-<h1 align="center">mkdocstrings-python</h1>
-
-<p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
-
-[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)
-[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
-[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)
-
----
-
-<p align="center"><img src="logo.png"></p>
-
-The Python handler uses [Griffe](https://mkdocstrings.github.io/griffe)
-to collect documentation from Python source code.
-The word "griffe" can sometimes be used instead of "signature" in French.
-Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information.
-It is also able to execute the code (by importing it) and introspect objects in memory
-when source code is not available. Finally, it can parse docstrings following different styles.
-
-## 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]>=0.18",
-]
-```
-
-You can also explicitly depend on the handler:
-
-```toml title="pyproject.toml"
-# PEP 621 dependencies declaration
-# adapt to your dependencies manager
-[project]
-dependencies = [
-    "mkdocstrings-python",
-]
-```
-
-## Preview
-
-<!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead -->
-![mkdocstrings_python_gif](https://user-images.githubusercontent.com/3999221/77157838-7184db80-6aa2-11ea-9f9a-fe77405202de.gif)
-
-## Features
-
-- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
-  [Griffe](https://github.com/mkdocstrings/griffe).
-
-- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them
-  to display parameter types or return types. It is even able to automatically add cross-references
-  to other objects from your API, from the standard library or third-party libraries!
-  See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it.
-
-- **Recursive documentation of Python objects:** just use the module dotted-path as an 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. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support.
-
-- **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 displayed 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.