mkdocstrings-python 1.10.6__tar.gz → 1.10.8__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mkdocstrings_python-1.10.8/CHANGELOG.md +684 -0
- mkdocstrings_python-1.10.8/CODE_OF_CONDUCT.md +133 -0
- mkdocstrings_python-1.10.8/CONTRIBUTING.md +149 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/PKG-INFO +2 -2
- mkdocstrings_python-1.10.8/config/black.toml +3 -0
- mkdocstrings_python-1.10.8/config/coverage.ini +26 -0
- mkdocstrings_python-1.10.8/config/git-changelog.toml +9 -0
- mkdocstrings_python-1.10.8/config/mypy.ini +7 -0
- mkdocstrings_python-1.10.8/config/pytest.ini +17 -0
- mkdocstrings_python-1.10.8/config/ruff.toml +84 -0
- mkdocstrings_python-1.10.8/config/vscode/launch.json +47 -0
- mkdocstrings_python-1.10.8/config/vscode/settings.json +33 -0
- mkdocstrings_python-1.10.8/config/vscode/tasks.json +97 -0
- mkdocstrings_python-1.10.8/devdeps.txt +32 -0
- mkdocstrings_python-1.10.8/docs/.glossary.md +12 -0
- mkdocstrings_python-1.10.8/docs/.overrides/main.html +20 -0
- mkdocstrings_python-1.10.8/docs/.overrides/partials/comments.html +57 -0
- mkdocstrings_python-1.10.8/docs/changelog.md +1 -0
- mkdocstrings_python-1.10.8/docs/code_of_conduct.md +1 -0
- mkdocstrings_python-1.10.8/docs/contributing.md +1 -0
- mkdocstrings_python-1.10.8/docs/credits.md +10 -0
- mkdocstrings_python-1.10.8/docs/css/insiders.css +124 -0
- mkdocstrings_python-1.10.8/docs/css/material.css +26 -0
- mkdocstrings_python-1.10.8/docs/css/mkdocstrings.css +27 -0
- mkdocstrings_python-1.10.8/docs/index.md +6 -0
- mkdocstrings_python-1.10.8/docs/insiders/changelog.md +51 -0
- mkdocstrings_python-1.10.8/docs/insiders/goals.yml +24 -0
- mkdocstrings_python-1.10.8/docs/insiders/index.md +242 -0
- mkdocstrings_python-1.10.8/docs/insiders/installation.md +88 -0
- mkdocstrings_python-1.10.8/docs/js/feedback.js +14 -0
- mkdocstrings_python-1.10.8/docs/js/insiders.js +74 -0
- mkdocstrings_python-1.10.8/docs/license.md +10 -0
- mkdocstrings_python-1.10.8/docs/logo.png +0 -0
- mkdocstrings_python-1.10.8/docs/schema.json +316 -0
- mkdocstrings_python-1.10.8/docs/usage/configuration/docstrings.md +1115 -0
- mkdocstrings_python-1.10.8/docs/usage/configuration/general.md +250 -0
- mkdocstrings_python-1.10.8/docs/usage/configuration/headings.md +517 -0
- mkdocstrings_python-1.10.8/docs/usage/configuration/members.md +691 -0
- mkdocstrings_python-1.10.8/docs/usage/configuration/signatures.md +405 -0
- mkdocstrings_python-1.10.8/docs/usage/customization.md +422 -0
- mkdocstrings_python-1.10.8/docs/usage/docstrings/google.md +28 -0
- mkdocstrings_python-1.10.8/docs/usage/docstrings/numpy.md +11 -0
- mkdocstrings_python-1.10.8/docs/usage/docstrings/sphinx.md +6 -0
- mkdocstrings_python-1.10.8/docs/usage/extensions.md +17 -0
- mkdocstrings_python-1.10.8/docs/usage/index.md +381 -0
- mkdocstrings_python-1.10.8/duties.py +224 -0
- mkdocstrings_python-1.10.8/mkdocs.yml +209 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/pyproject.toml +14 -2
- mkdocstrings_python-1.10.8/scripts/.cache/plugin/git-committers/page-authors.json +1 -0
- mkdocstrings_python-1.10.8/scripts/gen_credits.py +179 -0
- mkdocstrings_python-1.10.8/scripts/gen_ref_nav.py +37 -0
- mkdocstrings_python-1.10.8/scripts/insiders.py +203 -0
- mkdocstrings_python-1.10.8/scripts/make +210 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/handler.py +2 -2
- mkdocstrings_python-1.10.8/tests/__init__.py +7 -0
- mkdocstrings_python-1.10.8/tests/conftest.py +96 -0
- mkdocstrings_python-1.10.8/tests/test_handler.py +174 -0
- mkdocstrings_python-1.10.8/tests/test_rendering.py +166 -0
- mkdocstrings_python-1.10.8/tests/test_themes.py +46 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/LICENSE +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/README.md +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/__init__.py +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/debug.py +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/py.typed +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/rendering.py +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/children.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/children.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/class.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/function.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/language.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/module.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/module.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/classes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/functions.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/modules.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/attribute.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/attribute.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/children.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/children.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/class.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/class.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/docstring.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/expression.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/expression.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/function.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/function.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/labels.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/labels.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/language.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/en.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/module.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/module.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/signature.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/signature.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/style.css +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/classes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/functions.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/modules.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/material/summary.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/language.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.6 → mkdocstrings_python-1.10.8}/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +0 -0
|
@@ -0,0 +1,684 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
All notable changes to this project will be documented in this file.
|
|
3
|
+
|
|
4
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
5
|
+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
<!-- insertion marker -->
|
|
8
|
+
## [1.10.8](https://github.com/mkdocstrings/python/releases/tag/1.10.8) - 2024-08-14
|
|
9
|
+
|
|
10
|
+
<small>[Compare with 1.10.7](https://github.com/mkdocstrings/python/compare/1.10.7...1.10.8)</small>
|
|
11
|
+
|
|
12
|
+
### Build
|
|
13
|
+
|
|
14
|
+
- Depend on Griffe 0.49 ([a87dcad](https://github.com/mkdocstrings/python/commit/a87dcad36065dc3171512e166ec632ee3e5b0a64) by Timothée Mazzucotelli).
|
|
15
|
+
|
|
16
|
+
## [1.10.7](https://github.com/mkdocstrings/python/releases/tag/1.10.7) - 2024-07-25
|
|
17
|
+
|
|
18
|
+
<small>[Compare with 1.10.6](https://github.com/mkdocstrings/python/compare/1.10.6...1.10.7)</small>
|
|
19
|
+
|
|
20
|
+
### Packaging
|
|
21
|
+
|
|
22
|
+
- Include tests and all relevant files for downstream packaging in source distribution
|
|
23
|
+
|
|
24
|
+
## [1.10.6](https://github.com/mkdocstrings/python/releases/tag/1.10.6) - 2024-07-25
|
|
25
|
+
|
|
26
|
+
<small>[Compare with 1.10.5](https://github.com/mkdocstrings/python/compare/1.10.5...1.10.6)</small>
|
|
27
|
+
|
|
28
|
+
### Bug Fixes
|
|
29
|
+
|
|
30
|
+
- Fix condition to display members (check all members, not just non-inherited ones) ([3d838a9](https://github.com/mkdocstrings/python/commit/3d838a96f77fa128cd6f2afa5ed0cb151ab225fd) by Timothée Mazzucotelli).
|
|
31
|
+
|
|
32
|
+
### Code Refactoring
|
|
33
|
+
|
|
34
|
+
- Update code for Griffe 0.48 (removing deprecation warnings) ([eff10cc](https://github.com/mkdocstrings/python/commit/eff10ccf0fa1b2e73df912048a15c2d6406a2c8b) by Timothée Mazzucotelli). [Issue-173](https://github.com/mkdocstrings/python/issues/173)
|
|
35
|
+
|
|
36
|
+
## [1.10.5](https://github.com/mkdocstrings/python/releases/tag/1.10.5) - 2024-06-19
|
|
37
|
+
|
|
38
|
+
<small>[Compare with 1.10.4](https://github.com/mkdocstrings/python/compare/1.10.4...1.10.5)</small>
|
|
39
|
+
|
|
40
|
+
### Bug Fixes
|
|
41
|
+
|
|
42
|
+
- Mix both previous checks for displaying objects: not imported or public ([587963b](https://github.com/mkdocstrings/python/commit/587963ba53f765c9d7eefbc2fb80bdbb11164850) by Timothée Mazzucotelli). [Issue-294](https://github.com/mkdocstrings/griffe/issues/294)
|
|
43
|
+
|
|
44
|
+
## [1.10.4](https://github.com/mkdocstrings/python/releases/tag/1.10.4) - 2024-06-18
|
|
45
|
+
|
|
46
|
+
<small>[Compare with 1.10.3](https://github.com/mkdocstrings/python/compare/1.10.3...1.10.4)</small>
|
|
47
|
+
|
|
48
|
+
### Code Refactoring
|
|
49
|
+
|
|
50
|
+
- Only filter out imported objects instead of non-public ones after applying filters ([e2f4b35](https://github.com/mkdocstrings/python/commit/e2f4b35d29eca6f68afbd2e728ef7542a2abc992) by Timothée Mazzucotelli). [Issue-mkdocstrings/griffe-294](https://github.com/mkdocstrings/griffe/issues/294)
|
|
51
|
+
- Update code for Griffe 0.46 to avoid deprecation warnings ([321b407](https://github.com/mkdocstrings/python/commit/321b407eb95195c44f3cf34d780784e0d6751998) by Timothée Mazzucotelli).
|
|
52
|
+
- Change `load_external_modules` default value to `None` to support new default mode in Griffe ([ae5896c](https://github.com/mkdocstrings/python/commit/ae5896c1604e9089162d0d63ec97a510a6bcef89) by Timothée Mazzucotelli).
|
|
53
|
+
|
|
54
|
+
## [1.10.3](https://github.com/mkdocstrings/python/releases/tag/1.10.3) - 2024-05-22
|
|
55
|
+
|
|
56
|
+
<small>[Compare with 1.10.2](https://github.com/mkdocstrings/python/compare/1.10.2...1.10.3)</small>
|
|
57
|
+
|
|
58
|
+
### Bug Fixes
|
|
59
|
+
|
|
60
|
+
- Don't crash when rendering the source of an object whose lineno is none ([64df00b](https://github.com/mkdocstrings/python/commit/64df00b9b757e9642d65cf425d32f5a2e0d75f38) by Timothée Mazzucotelli). [Issue-163](https://github.com/mkdocstrings/python/issues/163)
|
|
61
|
+
|
|
62
|
+
## [1.10.2](https://github.com/mkdocstrings/python/releases/tag/1.10.2) - 2024-05-16
|
|
63
|
+
|
|
64
|
+
<small>[Compare with 1.10.1](https://github.com/mkdocstrings/python/compare/1.10.1...1.10.2)</small>
|
|
65
|
+
|
|
66
|
+
### Bug Fixes
|
|
67
|
+
|
|
68
|
+
- Actually make use of custom .html.jinja templates ([5668abb](https://github.com/mkdocstrings/python/commit/5668abba15b13b86fe67f70f6b4004b7b1feeb4f) by Timothée Mazzucotelli).
|
|
69
|
+
|
|
70
|
+
## [1.10.1](https://github.com/mkdocstrings/python/releases/tag/1.10.1) - 2024-05-14
|
|
71
|
+
|
|
72
|
+
<small>[Compare with 1.10.0](https://github.com/mkdocstrings/python/compare/1.10.0...1.10.1)</small>
|
|
73
|
+
|
|
74
|
+
### Build
|
|
75
|
+
|
|
76
|
+
- Depend on mkdocstrings 0.25 which adds support for parameter `once` when logging messages ([2bc156b](https://github.com/mkdocstrings/python/commit/2bc156bd6f231ae13066651f4490d1e9c2ce3ca2) by Timothée Mazzucotelli).
|
|
77
|
+
|
|
78
|
+
### Code Refactoring
|
|
79
|
+
|
|
80
|
+
- Set handler's name ([a71ab12](https://github.com/mkdocstrings/python/commit/a71ab12c8e52efe76e5c0a5e54065926a47cc0d2) by Timothée Mazzucotelli).
|
|
81
|
+
- Update `*.html` top-level templates to extend the `*.html.jinja` base templates ([a8c540e](https://github.com/mkdocstrings/python/commit/a8c540e95693e8500da884c32ad159b3bbaaa7ba) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
82
|
+
- Update `*.html` base templates to extend their `*.html.jinja` counterpart, while overriding the `logs` block to issue a logging message (info) stating that extending `*.html` templates is deprecated ([e6f1b9c](https://github.com/mkdocstrings/python/commit/e6f1b9caf13754eca9dbb2f112727bef50876ed7) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
83
|
+
- Add `*.html.jinja` top-level (overridable) templates, extending their base counterpart ([7c14924](https://github.com/mkdocstrings/python/commit/7c14924c406d7b5f4f1c22d03019d4c566018d2d) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
84
|
+
- Add `*.html.jinja` base templates, which are copies of `*.html` templates, with an additional `logs` block, and using the updated `get_template` filter ([eced9a5](https://github.com/mkdocstrings/python/commit/eced9a54fc8a559b686cb1b1180a0d2e04ba452d) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
85
|
+
- Update `get_template` filter to support both `*.html` and `*.html.jinja` templates, logging a message (info) when `*.html` templates are overridden by users ([3546fd7](https://github.com/mkdocstrings/python/commit/3546fd70b2d4e45f77b166b2e67c333acc8af0d2) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
86
|
+
- Log a warning when base templates are overridden ([26e3d66](https://github.com/mkdocstrings/python/commit/26e3d66f5334a5aaff75bda030afe6dfa1cc94d7) by Timothée Mazzucotelli). [Issue-151](https://github.com/mkdocstrings/python/issues/151)
|
|
87
|
+
|
|
88
|
+
## [1.10.0](https://github.com/mkdocstrings/python/releases/tag/1.10.0) - 2024-04-19
|
|
89
|
+
|
|
90
|
+
<small>[Compare with 1.9.2](https://github.com/mkdocstrings/python/compare/1.9.2...1.10.0)</small>
|
|
91
|
+
|
|
92
|
+
### Features
|
|
93
|
+
|
|
94
|
+
- Add CSS classes `doc-section-title` and `doc-section-item` in docstring sections ([d6e1d68](https://github.com/mkdocstrings/python/commit/d6e1d68c099e61c3bd6d93e583708335d84158f5) by Timothée Mazzucotelli). [Issue-17](https://github.com/mkdocstrings/python/issues/17)
|
|
95
|
+
|
|
96
|
+
### Bug Fixes
|
|
97
|
+
|
|
98
|
+
- Render enumeration instance name instead of just "value", allowing proper cross-reference ([11d81d8](https://github.com/mkdocstrings/python/commit/11d81d8e056b7c074eb3a1c47606867156a338fa) by Timothée Mazzucotelli). [Issue-124](https://github.com/mkdocstrings/python/issues/124)
|
|
99
|
+
|
|
100
|
+
## [1.9.2](https://github.com/mkdocstrings/python/releases/tag/1.9.2) - 2024-04-02
|
|
101
|
+
|
|
102
|
+
<small>[Compare with 1.9.1](https://github.com/mkdocstrings/python/compare/1.9.1...1.9.2)</small>
|
|
103
|
+
|
|
104
|
+
### Dependencies
|
|
105
|
+
|
|
106
|
+
- Remove cap on Python-Markdown 3.6 now that ToC labels are fixed by mkdocstrings ([0c1e2c1](https://github.com/mkdocstrings/python/commit/0c1e2c15b2497d99974cbb9bd68f25056bb8451b) by Timothée Mazzucotelli).
|
|
107
|
+
|
|
108
|
+
## [1.9.1](https://github.com/mkdocstrings/python/releases/tag/1.9.1) - 2024-04-02
|
|
109
|
+
|
|
110
|
+
<small>[Compare with 1.9.0](https://github.com/mkdocstrings/python/compare/1.9.0...1.9.1)</small>
|
|
111
|
+
|
|
112
|
+
### Bug Fixes
|
|
113
|
+
|
|
114
|
+
- Don't try loading packages from relative paths ([bd73497](https://github.com/mkdocstrings/python/commit/bd7349714059afb1295e743dbc82380fa797a032) by Timothée Mazzucotelli). [Issue-145](https://github.com/mkdocstrings/python/issues/145)
|
|
115
|
+
|
|
116
|
+
### Code Refactoring
|
|
117
|
+
|
|
118
|
+
- Allow first name in a separate signature to be highlighted as a function name ([f798a1e](https://github.com/mkdocstrings/python/commit/f798a1e19dbac548420dcbe1172e9a49232b615b) by Timothée Mazzucotelli).
|
|
119
|
+
- Maintain original Pygments color for cross-refs in signatures ([7c8b885](https://github.com/mkdocstrings/python/commit/7c8b885fa2b704e719016acb35791723ea3a496a) by Timothée Mazzucotelli).
|
|
120
|
+
|
|
121
|
+
## [1.9.0](https://github.com/mkdocstrings/python/releases/tag/1.9.0) - 2024-03-13
|
|
122
|
+
|
|
123
|
+
<small>[Compare with 1.8.0](https://github.com/mkdocstrings/python/compare/1.8.0...1.9.0)</small>
|
|
124
|
+
|
|
125
|
+
### Dependencies
|
|
126
|
+
|
|
127
|
+
- Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes ([cd93ee3](https://github.com/mkdocstrings/python/commit/cd93ee31418a2752667d43bb5a05d22284522c24) by Timothée Mazzucotelli).
|
|
128
|
+
|
|
129
|
+
### Features
|
|
130
|
+
|
|
131
|
+
- Add `show_labels` option to show/hide labels ([eaf9b82](https://github.com/mkdocstrings/python/commit/eaf9b8240069f7369f401fe048892043c8b173d3) by Viicos). [Issue #120](https://github.com/mkdocstrings/python/issues/120), [PR #130](https://github.com/mkdocstrings/python/pull/130)
|
|
132
|
+
- Add option to search for stubs packages ([0c6aa32](https://github.com/mkdocstrings/python/commit/0c6aa323c9e57b8348765a5daa11c79d0c5edb07) by Romain). [PR #128](https://github.com/mkdocstrings/python/pull/128), PR griffe#221: : https://github.com/mkdocstrings/griffe/pull/221
|
|
133
|
+
|
|
134
|
+
### Code Refactoring
|
|
135
|
+
|
|
136
|
+
- Mark all Jinja blocks as scoped ([548bdad](https://github.com/mkdocstrings/python/commit/548bdaddd66ffc99b3b9a5a62228a2ff4ff0dd00) by Timothée Mazzucotelli).
|
|
137
|
+
|
|
138
|
+
## [1.8.0](https://github.com/mkdocstrings/python/releases/tag/1.8.0) - 2024-01-08
|
|
139
|
+
|
|
140
|
+
<small>[Compare with 1.7.5](https://github.com/mkdocstrings/python/compare/1.7.5...1.8.0)</small>
|
|
141
|
+
|
|
142
|
+
### Features
|
|
143
|
+
|
|
144
|
+
- Release Insiders features of the $500/month funding goal ([bd30106](https://github.com/mkdocstrings/python/commit/bd301061fe9c647f9b91c2c9b4baa784c304eca7) by Timothée Mazzucotelli).
|
|
145
|
+
The features and projects related to *mkdocstrings-python* are:
|
|
146
|
+
|
|
147
|
+
- [Cross-references for type annotations in signatures](https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs)
|
|
148
|
+
- [Symbol types in headings and table of contents](https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc)
|
|
149
|
+
- [`griffe-inherited-docstrings`](https://mkdocstrings.github.io/griffe-inherited-docstrings/), a Griffe extension for inheriting docstrings
|
|
150
|
+
- [`griffe2md`](https://mkdocstrings.github.io/griffe2md/), a tool to output API docs to Markdown using Griffe
|
|
151
|
+
|
|
152
|
+
See the complete list of features and projects here:
|
|
153
|
+
https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.
|
|
154
|
+
|
|
155
|
+
## [1.7.5](https://github.com/mkdocstrings/python/releases/tag/1.7.5) - 2023-11-21
|
|
156
|
+
|
|
157
|
+
<small>[Compare with 1.7.4](https://github.com/mkdocstrings/python/compare/1.7.4...1.7.5)</small>
|
|
158
|
+
|
|
159
|
+
### Bug Fixes
|
|
160
|
+
|
|
161
|
+
- Add missing translations (fallback theme) for ReadTheDocs ([2fb6513](https://github.com/mkdocstrings/python/commit/2fb651304d0a80fa9d6a8c77c16b3004bda22972) by Timothée Mazzucotelli). [Issue #115](https://github.com/mkdocstrings/python/issues/115)
|
|
162
|
+
|
|
163
|
+
## [1.7.4](https://github.com/mkdocstrings/python/releases/tag/1.7.4) - 2023-11-12
|
|
164
|
+
|
|
165
|
+
<small>[Compare with 1.7.3](https://github.com/mkdocstrings/python/compare/1.7.3...1.7.4)</small>
|
|
166
|
+
|
|
167
|
+
### Bug Fixes
|
|
168
|
+
|
|
169
|
+
- Make extension paths relative to config file ([5035e92](https://github.com/mkdocstrings/python/commit/5035e9269fe11664fd25e438ac8f746721b3de0a) by Waylan Limberg). [PR #112](https://github.com/mkdocstrings/python/pull/112), Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
|
|
170
|
+
|
|
171
|
+
### Code Refactoring
|
|
172
|
+
|
|
173
|
+
- Prepare for Griffe 0.37 ([b5bb8a9](https://github.com/mkdocstrings/python/commit/b5bb8a982e7a2ec97c73335e453d0033bf4987b6) by Timothée Mazzucotelli).
|
|
174
|
+
|
|
175
|
+
## [1.7.3](https://github.com/mkdocstrings/python/releases/tag/1.7.3) - 2023-10-09
|
|
176
|
+
|
|
177
|
+
<small>[Compare with 1.7.2](https://github.com/mkdocstrings/python/compare/1.7.2...1.7.3)</small>
|
|
178
|
+
|
|
179
|
+
### Bug Fixes
|
|
180
|
+
|
|
181
|
+
- Don't deepcopy the local config ([1300d2c](https://github.com/mkdocstrings/python/commit/1300d2c77dd49f5dea459ad844d72edcc856c4cd) by Timothée Mazzucotelli).
|
|
182
|
+
|
|
183
|
+
## [1.7.2](https://github.com/mkdocstrings/python/releases/tag/1.7.2) - 2023-10-05
|
|
184
|
+
|
|
185
|
+
<small>[Compare with 1.7.1](https://github.com/mkdocstrings/python/compare/1.7.1...1.7.2)</small>
|
|
186
|
+
|
|
187
|
+
### Bug Fixes
|
|
188
|
+
|
|
189
|
+
- Prevent alias resolution error when source-ordering members ([67df10c](https://github.com/mkdocstrings/python/commit/67df10cbb86225e1e3efc251325cbff883a1ef3c) by Timothée Mazzucotelli). [Issue griffe#213](https://github.com/mkdocstrings/griffe/issues/213)
|
|
190
|
+
|
|
191
|
+
### Code Refactoring
|
|
192
|
+
|
|
193
|
+
- Use package relative filepath if filepath is not relative ([aa5a3f7](https://github.com/mkdocstrings/python/commit/aa5a3f7b0928498ba9da10ed1211d1e55b7f6c4b) by Timothée Mazzucotelli). [Discussion mkdocstrings#622](https://github.com/mkdocstrings/mkdocstrings/discussions/622)
|
|
194
|
+
|
|
195
|
+
## [1.7.1](https://github.com/mkdocstrings/python/releases/tag/1.7.1) - 2023-09-28
|
|
196
|
+
|
|
197
|
+
<small>[Compare with 1.7.0](https://github.com/mkdocstrings/python/compare/1.7.0...1.7.1)</small>
|
|
198
|
+
|
|
199
|
+
### Bug Fixes
|
|
200
|
+
|
|
201
|
+
- Stop propagation of annotation to next parameter in signature template ([3a760ac](https://github.com/mkdocstrings/python/commit/3a760acacfabaef5abc658ee579e1c205e674994) by Timothée Mazzucotelli). [Issue #110](https://github.com/mkdocstrings/python/issues/110)
|
|
202
|
+
|
|
203
|
+
### Code Refactoring
|
|
204
|
+
|
|
205
|
+
- Look into inherited members for `__init__` methods when merging docstrings ([b97d51f](https://github.com/mkdocstrings/python/commit/b97d51f67c2ee3d1edfe6975274ead50fcb3fa8f) by Timothée Mazzucotelli). [Issue #106](https://github.com/mkdocstrings/python/issues/106)
|
|
206
|
+
|
|
207
|
+
## [1.7.0](https://github.com/mkdocstrings/python/releases/tag/1.7.0) - 2023-09-14
|
|
208
|
+
|
|
209
|
+
<small>[Compare with 1.6.3](https://github.com/mkdocstrings/python/compare/1.6.3...1.7.0)</small>
|
|
210
|
+
|
|
211
|
+
### Features
|
|
212
|
+
|
|
213
|
+
- Add option to unwrap `Annotated` types ([53db04b](https://github.com/mkdocstrings/python/commit/53db04b6256db960aebc2a9f91129b82ca222e41) by Timothée Mazzucotelli).
|
|
214
|
+
|
|
215
|
+
## [1.6.3](https://github.com/mkdocstrings/python/releases/tag/1.6.3) - 2023-09-11
|
|
216
|
+
|
|
217
|
+
<small>[Compare with 1.6.2](https://github.com/mkdocstrings/python/compare/1.6.2...1.6.3)</small>
|
|
218
|
+
|
|
219
|
+
### Bug Fixes
|
|
220
|
+
|
|
221
|
+
- Make `load_external_modules` a global-only option ([266f41f](https://github.com/mkdocstrings/python/commit/266f41f2033e034060001bc2bed376b4f3a8d7b8) by Timothée Mazzucotelli). [Issue #87](https://github.com/mkdocstrings/python/issues/87)
|
|
222
|
+
- Never fail when trying to format code with Black ([df24bbc](https://github.com/mkdocstrings/python/commit/df24bbc640886e1da2d00a3b58c1aa7736cb1eeb) by Timothée Mazzucotelli).
|
|
223
|
+
|
|
224
|
+
### Code Refactoring
|
|
225
|
+
|
|
226
|
+
- Wrap docstring section elements (list style) in code tags to prevent spell checker errors ([1ae8dd8](https://github.com/mkdocstrings/python/commit/1ae8dd89cddd67c09d7d30c59b9013516cea2924) by Timothée Mazzucotelli).
|
|
227
|
+
|
|
228
|
+
## [1.6.2](https://github.com/mkdocstrings/python/releases/tag/1.6.2) - 2023-09-05
|
|
229
|
+
|
|
230
|
+
<small>[Compare with 1.6.1](https://github.com/mkdocstrings/python/compare/1.6.1...1.6.2)</small>
|
|
231
|
+
|
|
232
|
+
### Bug Fixes
|
|
233
|
+
|
|
234
|
+
- Don't render cross-ref spans when they're not enabled ([eed51ee](https://github.com/mkdocstrings/python/commit/eed51ee14bd973a08395f95377f9bd4cd38febfc) by Timothée Mazzucotelli).
|
|
235
|
+
|
|
236
|
+
## [1.6.1](https://github.com/mkdocstrings/python/releases/tag/1.6.1) - 2023-09-04
|
|
237
|
+
|
|
238
|
+
<small>[Compare with 1.6.0](https://github.com/mkdocstrings/python/compare/1.6.0...1.6.1)</small>
|
|
239
|
+
|
|
240
|
+
### Bug Fixes
|
|
241
|
+
|
|
242
|
+
- Fix spacing for rendered named items in Yields, Receives and Returns sections (list style) ([e12688e](https://github.com/mkdocstrings/python/commit/e12688ecb7d868047f794300eb2638d052563e68) by Timothée Mazzucotelli).
|
|
243
|
+
- Fix rendering Receives sections as lists ([9ff7e68](https://github.com/mkdocstrings/python/commit/9ff7e68b58e2ab0829c73e4e62254325a4f766ac) by Timothée Mazzucotelli).
|
|
244
|
+
|
|
245
|
+
## [1.6.0](https://github.com/mkdocstrings/python/releases/tag/1.6.0) - 2023-08-27
|
|
246
|
+
|
|
247
|
+
<small>[Compare with 1.5.2](https://github.com/mkdocstrings/python/compare/1.5.2...1.6.0)</small>
|
|
248
|
+
|
|
249
|
+
### Features
|
|
250
|
+
|
|
251
|
+
- Add `doc-signature` CSS class to separate signature code blocks ([b6c648f](https://github.com/mkdocstrings/python/commit/b6c648f554f2e0dce609afc2a2c1a3b27a4fbeba) by Timothée Mazzucotelli).
|
|
252
|
+
|
|
253
|
+
### Code Refactoring
|
|
254
|
+
|
|
255
|
+
- Add a `format_attribute` filter, preparing for cross-refs in attribute signatures ([8f0ade2](https://github.com/mkdocstrings/python/commit/8f0ade249638ee2f2d446f083c70b6c30799875a) by Timothée Mazzucotelli).
|
|
256
|
+
|
|
257
|
+
## [1.5.2](https://github.com/mkdocstrings/python/releases/tag/1.5.2) - 2023-08-25
|
|
258
|
+
|
|
259
|
+
<small>[Compare with 1.5.1](https://github.com/mkdocstrings/python/compare/1.5.1...1.5.2)</small>
|
|
260
|
+
|
|
261
|
+
### Bug Fixes
|
|
262
|
+
|
|
263
|
+
- Regression in children template: fix condition for when members are specified ([beeebff](https://github.com/mkdocstrings/python/commit/beeebffa36288d1f71d122f78ecd9064b41a75d0) by Timothée Mazzucotelli). [Issue #100](https://github.com/mkdocstrings/python/issues/100)
|
|
264
|
+
- Prevent whitespace removal before highlight filter ([c6f36c0](https://github.com/mkdocstrings/python/commit/c6f36c0c9e5141800f8c5c988c9b67720fccccb8) by Timothée Mazzucotelli).
|
|
265
|
+
|
|
266
|
+
### Code Refactoring
|
|
267
|
+
|
|
268
|
+
- Never show full object path in ToC entry ([9aa758b](https://github.com/mkdocstrings/python/commit/9aa758bcc42dfcf7c416d87b8f7cd407b7fdf148) by Timothée Mazzucotelli).
|
|
269
|
+
- Sync templates with insiders, remove useless lines ([38b317f](https://github.com/mkdocstrings/python/commit/38b317f4fc74b583a4788721a5559c51a5a47d86) by Timothée Mazzucotelli).
|
|
270
|
+
|
|
271
|
+
## [1.5.1](https://github.com/mkdocstrings/python/releases/tag/1.5.1) - 2023-08-24
|
|
272
|
+
|
|
273
|
+
<small>[Compare with 1.5.0](https://github.com/mkdocstrings/python/compare/1.5.0...1.5.1)</small>
|
|
274
|
+
|
|
275
|
+
### Code Refactoring
|
|
276
|
+
|
|
277
|
+
- Never show full path in separate signature since it would appear in the heading already ([9e02049](https://github.com/mkdocstrings/python/commit/9e0204930cf4dc973ba8eb41c471fc0132e1631f) by Timothée Mazzucotelli).
|
|
278
|
+
- Improve guessing whether an object is public ([35eb811](https://github.com/mkdocstrings/python/commit/35eb81162582d794f170cd7e8c68f10ecfd8ff9d) by Timothée Mazzucotelli).
|
|
279
|
+
- Always sort modules alphabetically as source order wouldn't make sense ([70c81ce](https://github.com/mkdocstrings/python/commit/70c81cebb62366cbfc6124bc84d1563db176afb6) by Timothée Mazzucotelli).
|
|
280
|
+
- Return anchors as a tuple, not a set, to preserve order ([736a2b5](https://github.com/mkdocstrings/python/commit/736a2b5e729d25bb184db8d42f2ad01025a5bc58) by Timothée Mazzucotelli). [Related-to #mkdocstrings/crystal#6](https://github.com/mkdocstrings/crystal/pull/6)
|
|
281
|
+
|
|
282
|
+
## [1.5.0](https://github.com/mkdocstrings/python/releases/tag/1.5.0) - 2023-08-20
|
|
283
|
+
|
|
284
|
+
<small>[Compare with 1.4.0](https://github.com/mkdocstrings/python/compare/1.4.0...1.5.0)</small>
|
|
285
|
+
|
|
286
|
+
### Features
|
|
287
|
+
|
|
288
|
+
- Add support for new Griffe docstring sections: modules, classes, and functions (methods) ([d5337af](https://github.com/mkdocstrings/python/commit/d5337afdf68fc492b34f749aa69d1da33b49f9c2) by Timothée Mazzucotelli).
|
|
289
|
+
|
|
290
|
+
## [1.4.0](https://github.com/mkdocstrings/python/releases/tag/1.4.0) - 2023-08-18
|
|
291
|
+
|
|
292
|
+
<small>[Compare with 1.3.0](https://github.com/mkdocstrings/python/compare/1.3.0...1.4.0)</small>
|
|
293
|
+
|
|
294
|
+
### Features
|
|
295
|
+
|
|
296
|
+
- Support new Griffe expressions (in v0.33) ([9b8e1b1](https://github.com/mkdocstrings/python/commit/9b8e1b1604b978cf2d89b7abf826cf4407f92394) by Timothée Mazzucotelli).
|
|
297
|
+
|
|
298
|
+
### Code Refactoring
|
|
299
|
+
|
|
300
|
+
- Deprecate `crossref` and `multi_crossref` filters ([4fe3d20](https://github.com/mkdocstrings/python/commit/4fe3d2051047061780e20683da6513a7c8d91829) by Timothée Mazzucotelli).
|
|
301
|
+
|
|
302
|
+
## [1.3.0](https://github.com/mkdocstrings/python/releases/tag/1.3.0) - 2023-08-06
|
|
303
|
+
|
|
304
|
+
<small>[Compare with 1.2.1](https://github.com/mkdocstrings/python/compare/1.2.1...1.3.0)</small>
|
|
305
|
+
|
|
306
|
+
### Dependencies
|
|
307
|
+
|
|
308
|
+
- Set upper bound on Griffe (0.33) ([ad8c2a3](https://github.com/mkdocstrings/python/commit/ad8c2a3ac8daf0b0c06579b6ba667e05feffa247) by Timothée Mazzucotelli). See https://github.com/mkdocstrings/griffe/discussions/195.
|
|
309
|
+
|
|
310
|
+
### Features
|
|
311
|
+
|
|
312
|
+
- Show parameter default values within the "list" section style too ([55f08f3](https://github.com/mkdocstrings/python/commit/55f08f3e2cece815dd79d35c82515ba8003ec64c) by Antoine Dechaume). [PR #92](https://github.com/mkdocstrings/python/pull/92), Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
|
|
313
|
+
|
|
314
|
+
## [1.2.1](https://github.com/mkdocstrings/python/releases/tag/1.2.1) - 2023-07-20
|
|
315
|
+
|
|
316
|
+
<small>[Compare with 1.2.0](https://github.com/mkdocstrings/python/compare/1.2.0...1.2.1)</small>
|
|
317
|
+
|
|
318
|
+
### Bug Fixes
|
|
319
|
+
|
|
320
|
+
- Fix members ordering when members are specified with a boolean ([c69f9c3](https://github.com/mkdocstrings/python/commit/c69f9c3b3ddde915619eded6620f7ddada977b00) by Timothée Mazzucotelli). [Issue #89](https://github.com/mkdocstrings/python/issues/89)
|
|
321
|
+
|
|
322
|
+
## [1.2.0](https://github.com/mkdocstrings/python/releases/tag/1.2.0) - 2023-07-14
|
|
323
|
+
|
|
324
|
+
<small>[Compare with 1.1.2](https://github.com/mkdocstrings/python/compare/1.1.2...1.2.0)</small>
|
|
325
|
+
|
|
326
|
+
### Features
|
|
327
|
+
|
|
328
|
+
- Add Jinja blocks to module, class, function and attribute templates ([299fe48](https://github.com/mkdocstrings/python/commit/299fe483cc03ba76df29b843f88467f89db6dc72) by Timothée Mazzucotelli).
|
|
329
|
+
- Setup infrastructure for I18N, add translations for simplified chinese and japanese ([b053b29](https://github.com/mkdocstrings/python/commit/b053b2900ef5c0069b68ad19bda9aaa98141a525) by Nyuan Zhang). [PR #77](https://github.com/mkdocstrings/python/pull/77)
|
|
330
|
+
- Support inheritance ([ae42356](https://github.com/mkdocstrings/python/commit/ae4235689155a4b4f0c1e74b0014a466c6b1181f) by Timothée Mazzucotelli). [Issue mkdocstrings#157](https://github.com/mkdocstrings/mkdocstrings/issues/157), [Discussion mkdocstrings#536](https://github.com/mkdocstrings/mkdocstrings/discussions/536)
|
|
331
|
+
|
|
332
|
+
### Bug Fixes
|
|
333
|
+
|
|
334
|
+
- Don't show `None` as return annotation of class signatures ([3d8724e](https://github.com/mkdocstrings/python/commit/3d8724ed1f4d040d7a3d9d02784cf0d1f80445b2) by Timothée Mazzucotelli). [Issue #85](https://github.com/mkdocstrings/python/issues/85)
|
|
335
|
+
- Show labels in deterministic order ([02619a8](https://github.com/mkdocstrings/python/commit/02619a85ee4aab25f3241d983bdfff0534dd3f81) by Oleh Prypin).
|
|
336
|
+
|
|
337
|
+
## [1.1.2](https://github.com/mkdocstrings/python/releases/tag/1.1.2) - 2023-06-04
|
|
338
|
+
|
|
339
|
+
<small>[Compare with 1.1.1](https://github.com/mkdocstrings/python/compare/1.1.1...1.1.2)</small>
|
|
340
|
+
|
|
341
|
+
### Code Refactoring
|
|
342
|
+
|
|
343
|
+
- Keep headings style consistent (CSS) ([92032e5](https://github.com/mkdocstrings/python/commit/92032e561861c3fc4e3fb0c6882bb076d0e6614d) by Timothée Mazzucotelli).
|
|
344
|
+
|
|
345
|
+
## [1.1.1](https://github.com/mkdocstrings/python/releases/tag/1.1.1) - 2023-06-04
|
|
346
|
+
|
|
347
|
+
<small>[Compare with 1.1.0](https://github.com/mkdocstrings/python/compare/1.1.0...1.1.1)</small>
|
|
348
|
+
|
|
349
|
+
### Bug Fixes
|
|
350
|
+
|
|
351
|
+
- Fix mkdocs and readthedocs themes support ([14f18b2](https://github.com/mkdocstrings/python/commit/14f18b219f67f9b6d154d4a52051d8d7d7c49348) by Timothée Mazzucotelli).
|
|
352
|
+
|
|
353
|
+
### Code Refactoring
|
|
354
|
+
|
|
355
|
+
- Improve display of paragraphs in docstring sections ([439f5e6](https://github.com/mkdocstrings/python/commit/439f5e6984fe94c28324ca57fbd1a52ef8f55b62) by Timothée Mazzucotelli).
|
|
356
|
+
|
|
357
|
+
## [1.1.0](https://github.com/mkdocstrings/python/releases/tag/1.1.0) - 2023-05-25
|
|
358
|
+
|
|
359
|
+
<small>[Compare with 1.0.0](https://github.com/mkdocstrings/python/compare/1.0.0...1.1.0)</small>
|
|
360
|
+
|
|
361
|
+
### Features
|
|
362
|
+
|
|
363
|
+
- Support custom templates through objects' extra data ([8ff2b06](https://github.com/mkdocstrings/python/commit/8ff2b06295e848b9c84867802eb845adf061dc10) by Timothée Mazzucotelli). [PR #70](https://github.com/mkdocstrings/python/pull/70)
|
|
364
|
+
|
|
365
|
+
## [1.0.0](https://github.com/mkdocstrings/python/releases/tag/1.0.0) - 2023-05-11
|
|
366
|
+
|
|
367
|
+
<small>[Compare with 0.10.1](https://github.com/mkdocstrings/python/compare/0.10.1...1.0.0)</small>
|
|
368
|
+
|
|
369
|
+
### Breaking changes
|
|
370
|
+
|
|
371
|
+
- The signature of the [`format_signature` filter](https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/rendering/#mkdocstrings_handlers.python.rendering.do_format_signature) has changed.
|
|
372
|
+
If you override templates in your project to customize the output,
|
|
373
|
+
make sure to update the following templates so that they use
|
|
374
|
+
the new filter signature:
|
|
375
|
+
|
|
376
|
+
- `class.html`
|
|
377
|
+
- `expression.html`
|
|
378
|
+
- `function.html`
|
|
379
|
+
- `signature.html`
|
|
380
|
+
|
|
381
|
+
You can see how to use the filter in this commit's changes:
|
|
382
|
+
[f686f4e4](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513).
|
|
383
|
+
|
|
384
|
+
**We take this as an opportunity to go out of beta and bump the version to 1.0.0.
|
|
385
|
+
This will allow users to rely on semantic versioning.**
|
|
386
|
+
|
|
387
|
+
### Bug Fixes
|
|
388
|
+
|
|
389
|
+
- Bring compatibility with insiders signature crossrefs feature ([f686f4e](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513) by Timothée Mazzucotelli).
|
|
390
|
+
|
|
391
|
+
## [0.10.1](https://github.com/mkdocstrings/python/releases/tag/0.10.1) - 2023-05-07
|
|
392
|
+
|
|
393
|
+
<small>[Compare with 0.10.0](https://github.com/mkdocstrings/python/compare/0.10.0...0.10.1)</small>
|
|
394
|
+
|
|
395
|
+
### Bug Fixes
|
|
396
|
+
|
|
397
|
+
- Format signatures with full-path names ([685512d](https://github.com/mkdocstrings/python/commit/685512decf1a14c53fa6ca82048e65619aa6a463) by Timothée Mazzucotelli).
|
|
398
|
+
|
|
399
|
+
## [0.10.0](https://github.com/mkdocstrings/python/releases/tag/0.10.0) - 2023-05-07
|
|
400
|
+
|
|
401
|
+
<small>[Compare with 0.9.0](https://github.com/mkdocstrings/python/compare/0.9.0...0.10.0)</small>
|
|
402
|
+
|
|
403
|
+
### Features
|
|
404
|
+
|
|
405
|
+
- Add option to disallow inspection ([40f2f26](https://github.com/mkdocstrings/python/commit/40f2f268876358941cf8221d01d219a0deb9de38) by Nyuan Zhang). [Issue #68](https://github.com/mkdocstrings/python/issues/68), [PR #69](https://github.com/mkdocstrings/python/pull/69)
|
|
406
|
+
|
|
407
|
+
### Bug Fixes
|
|
408
|
+
|
|
409
|
+
- Make admonitions open by default ([79cd153](https://github.com/mkdocstrings/python/commit/79cd153cfceec860f6ce08d30817c21031983238) by Timothée Mazzucotelli). [Issue #22](https://github.com/mkdocstrings/python/issues/22)
|
|
410
|
+
|
|
411
|
+
### Code Refactoring
|
|
412
|
+
|
|
413
|
+
- Match documented behavior for filtering (all members, list, none) ([c7f70c3](https://github.com/mkdocstrings/python/commit/c7f70c353c3dd2b82e1f34c70cd433e0bab4f6e6) by Timothée Mazzucotelli).
|
|
414
|
+
- Switch to an info level log for when black's not installed ([f593bb0](https://github.com/mkdocstrings/python/commit/f593bb06c63860be14d2025c4bd795e0c8976ce0) by Faster Speeding).
|
|
415
|
+
- Return anchors as a set ([e2b820c](https://github.com/mkdocstrings/python/commit/e2b820c5af3787518656d5f7f799ecb6b55aa033) by Timothée Mazzucotelli).
|
|
416
|
+
|
|
417
|
+
## [0.9.0](https://github.com/mkdocstrings/python/releases/tag/0.9.0) - 2023-04-03
|
|
418
|
+
|
|
419
|
+
<small>[Compare with 0.8.3](https://github.com/mkdocstrings/python/compare/0.8.3...0.9.0)</small>
|
|
420
|
+
|
|
421
|
+
### Features
|
|
422
|
+
|
|
423
|
+
- Allow resolving alias to external modules ([02052e2](https://github.com/mkdocstrings/python/commit/02052e248b125a113ab788faa9a075adbdc92ca6) by Gilad). [PR #61](https://github.com/mkdocstrings/python/pull/61), [Follow-up of PR #60](https://github.com/mkdocstrings/python/pull/60)
|
|
424
|
+
- Allow pre-loading modules ([36002cb](https://github.com/mkdocstrings/python/commit/36002cb9c89fba35d23afb07a866dd8c6877f742) by Gilad). [Issue mkdocstrings/mkdocstrings#503](https://github.com/mkdocstrings/mkdocstrings/issues/503), [PR #60](https://github.com/mkdocstrings/python/pull/60)
|
|
425
|
+
- Add show options for docstrings ([a6c55fb](https://github.com/mkdocstrings/python/commit/a6c55fb52f362dd49b1a7e334a631f6ea3b1b963) by Jeremy Goh). [Issue mkdocstrings/mkdocstrings#466](https://github.com/mkdocstrings/mkdocstrings/issues/466), [PR #56](https://github.com/mkdocstrings/python/pull/56)
|
|
426
|
+
- Allow custom list of domains for inventories ([f5ea6fd](https://github.com/mkdocstrings/python/commit/f5ea6fd81f7a531e8a97bb0e48267188d72936c1) by Sorin Sbarnea). [Issue mkdocstrings/mkdocstrings#510](https://github.com/mkdocstrings/mkdocstrings/issues/510), [PR #49](https://github.com/mkdocstrings/python/pull/49)
|
|
427
|
+
|
|
428
|
+
### Bug Fixes
|
|
429
|
+
|
|
430
|
+
- Prevent alias resolution error when searching for anchors ([a190e2c](https://github.com/mkdocstrings/python/commit/a190e2c4a752e74a05ad03702837a0914c198742) by Timothée Mazzucotelli). [Issue #64](https://github.com/mkdocstrings/python/issues/64)
|
|
431
|
+
|
|
432
|
+
### Code Refactoring
|
|
433
|
+
|
|
434
|
+
- Support Griffe 0.26 ([075735c](https://github.com/mkdocstrings/python/commit/075735ce8d86921fbf092d7ad1d009bbb3a2e0bb) by Timothée Mazzucotelli).
|
|
435
|
+
- Log (debug) unresolved aliases ([9164742](https://github.com/mkdocstrings/python/commit/9164742f87362e8241dea11bec0fd96f6b9d9dda) by Timothée Mazzucotelli).
|
|
436
|
+
|
|
437
|
+
## [0.8.3](https://github.com/mkdocstrings/python/releases/tag/0.8.3) - 2023-01-04
|
|
438
|
+
|
|
439
|
+
<small>[Compare with 0.8.2](https://github.com/mkdocstrings/python/compare/0.8.2...0.8.3)</small>
|
|
440
|
+
|
|
441
|
+
### Code Refactoring
|
|
442
|
+
- Change "unresolved aliases" log level to DEBUG ([dccb818](https://github.com/mkdocstrings/python/commit/dccb818f51278cc8799e2187a615d999a3ab86fb) by Timothée Mazzucotelli).
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
## [0.8.2](https://github.com/mkdocstrings/python/releases/tag/0.8.2) - 2022-11-19
|
|
446
|
+
|
|
447
|
+
<small>[Compare with 0.8.1](https://github.com/mkdocstrings/python/compare/0.8.1...0.8.2)</small>
|
|
448
|
+
|
|
449
|
+
### Bug Fixes
|
|
450
|
+
- Fix base directory used to expand globs ([34cfa4b](https://github.com/mkdocstrings/python/commit/34cfa4b41f264437a338e66f6060ceeee134ba15) by Florian Hofer). [PR #45](https://github.com/mkdocstrings/python/pull/45)
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
## [0.8.1](https://github.com/mkdocstrings/python/releases/tag/0.8.1) - 2022-11-19
|
|
454
|
+
|
|
455
|
+
<small>[Compare with 0.8.0](https://github.com/mkdocstrings/python/compare/0.8.0...0.8.1)</small>
|
|
456
|
+
|
|
457
|
+
### Bug Fixes
|
|
458
|
+
- Expand globs relative to configuration file path ([0dc45ae](https://github.com/mkdocstrings/python/commit/0dc45aeb7c7f9b2f15118ebf1584baa06d365c9b) by David Vegh). [Issue #42](https://github.com/mkdocstrings/python/issues/42), [PR #43](https://github.com/mkdocstrings/python/pull/43)
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
## [0.8.0](https://github.com/mkdocstrings/python/releases/tag/0.8.0) - 2022-11-13
|
|
462
|
+
|
|
463
|
+
<small>[Compare with 0.7.1](https://github.com/mkdocstrings/python/compare/0.7.1...0.8.0)</small>
|
|
464
|
+
|
|
465
|
+
### Features
|
|
466
|
+
- Add support for globs in paths configuration ([29edd02](https://github.com/mkdocstrings/python/commit/29edd02e7a4d83f6b7e8555d4d5b03a79882eb07) by Andrew Guenther). [Issue #33](https://github.com/mkdocstrings/python/issues/33), [PR #34](https://github.com/mkdocstrings/python/pull/34)
|
|
467
|
+
|
|
468
|
+
### Code Refactoring
|
|
469
|
+
- Support Griffe 0.24 ([3b9f701](https://github.com/mkdocstrings/python/commit/3b9f7013a7367f18e4354c37f029f9caf3ad0a4e) by Timothée Mazzucotelli).
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
## [0.7.1](https://github.com/mkdocstrings/python/releases/tag/0.7.1) - 2022-06-12
|
|
473
|
+
|
|
474
|
+
<small>[Compare with 0.7.0](https://github.com/mkdocstrings/python/compare/0.7.0...0.7.1)</small>
|
|
475
|
+
|
|
476
|
+
### Bug Fixes
|
|
477
|
+
- Fix rendering of `/` in signatures ([3e927e4](https://github.com/mkdocstrings/python/commit/3e927e43192710218fe69f67ff832936c856a678) by Timothée Mazzucotelli). [Issue #25](https://github.com/mkdocstrings/python/issues/25)
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
## [0.7.0](https://github.com/mkdocstrings/python/releases/tag/0.7.0) - 2022-05-28
|
|
481
|
+
|
|
482
|
+
<small>[Compare with 0.6.6](https://github.com/mkdocstrings/python/compare/0.6.6...0.7.0)</small>
|
|
483
|
+
|
|
484
|
+
### Packaging / Dependencies
|
|
485
|
+
- Depend on mkdocstrings 0.19 ([b6a9a47](https://github.com/mkdocstrings/python/commit/b6a9a4799980c4590a7ce2838e12653f40e43be3) by Timothée Mazzucotelli).
|
|
486
|
+
|
|
487
|
+
### Features
|
|
488
|
+
- Add config option for annotations paths verbosity ([b6c9893](https://github.com/mkdocstrings/python/commit/b6c989315fb028813a919319ad1818b0b1f597ac) by Timothée Mazzucotelli).
|
|
489
|
+
- Use sections titles in SpaCy-styled docstrings ([fe16b54](https://github.com/mkdocstrings/python/commit/fe16b54aea60473575343e3a3c428567b701bd7d) by Timothée Mazzucotelli).
|
|
490
|
+
- Wrap objects names in spans to allow custom styling ([0822ff9](https://github.com/mkdocstrings/python/commit/0822ff9d3ffd3fb71fb619a8b557160661eff9c3) by Timothée Mazzucotelli). [Issue mkdocstrings/mkdocstrings#240](https://github.com/mkdocstrings/mkdocstrings/issues/240)
|
|
491
|
+
- Add Jinja blocks around docstring section styles ([aaa79ee](https://github.com/mkdocstrings/python/commit/aaa79eea40d49a64a69badbe732bf5211fbf055a) by Timothée Mazzucotelli).
|
|
492
|
+
- Add members and filters options ([24a6136](https://github.com/mkdocstrings/python/commit/24a6136ee6c04a6a49ee74b20e65177868a10ea7) by Timothée Mazzucotelli).
|
|
493
|
+
- Add paths option ([dd41182](https://github.com/mkdocstrings/python/commit/dd41182c210f0bb2675ead162adaa01dbbb1949f) by Timothée Mazzucotelli). [Issue mkdocstrings/mkdocstrings#311](https://github.com/mkdocstrings/mkdocstrings/issues/311), [PR #20](https://github.com/mkdocstrings/python/issues/20)
|
|
494
|
+
|
|
495
|
+
### Bug Fixes
|
|
496
|
+
- Fix CSS class on labels ([312a709](https://github.com/mkdocstrings/python/commit/312a7092394aab968032cf08195af7445a85052f) by Timothée Mazzucotelli).
|
|
497
|
+
- Fix categories rendering ([6407cf4](https://github.com/mkdocstrings/python/commit/6407cf4f2375c894e0c528e932e9b76774a6455e) by Timothée Mazzucotelli). [Issue #14](https://github.com/mkdocstrings/python/issues/14)
|
|
498
|
+
|
|
499
|
+
### Code Refactoring
|
|
500
|
+
- Disable `show_submodules` by default ([480d0c3](https://github.com/mkdocstrings/python/commit/480d0c373904713313ec76b6e2570dbc35eb527b) by Timothée Mazzucotelli).
|
|
501
|
+
- Merge default configuration options in handler ([347ce76](https://github.com/mkdocstrings/python/commit/347ce76d074c0e3841df2d5162b54d3938d00453) by Timothée Mazzucotelli).
|
|
502
|
+
- Reduce number of template debug logs ([8fed314](https://github.com/mkdocstrings/python/commit/8fed314243e3981fc7b527c69cee628e87b10220) by Timothée Mazzucotelli).
|
|
503
|
+
- Respect `show_root_full_path` for ToC entries (hidden headings) ([8f4c853](https://github.com/mkdocstrings/python/commit/8f4c85328e8b4a45db77f9fc3e536a5008686f37) by Timothée Mazzucotelli).
|
|
504
|
+
- Bring consistency on headings style ([59104c4](https://github.com/mkdocstrings/python/commit/59104c4c51c86c774eed76d8508f9f4d3db5463f) by Timothée Mazzucotelli).
|
|
505
|
+
- Stop using deprecated base classes ([d5ea1c5](https://github.com/mkdocstrings/python/commit/d5ea1c5cf7884d8c019145f73685a84218e69840) by Timothée Mazzucotelli).
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
## [0.6.6](https://github.com/mkdocstrings/python/releases/tag/0.6.6) - 2022-03-06
|
|
509
|
+
|
|
510
|
+
<small>[Compare with 0.6.5](https://github.com/mkdocstrings/python/compare/0.6.5...0.6.6)</small>
|
|
511
|
+
|
|
512
|
+
### Code Refactoring
|
|
513
|
+
- Always hide `self` and `cls` parameters ([7f579d1](https://github.com/mkdocstrings/python/commit/7f579d162e184adcfe25b2215bce4d38677f75b7) by Timothée Mazzucotelli). [Issue #7](https://github.com/mkdocstrings/python/issues/7)
|
|
514
|
+
- Use `pycon` for examples code blocks ([6545900](https://github.com/mkdocstrings/python/commit/6545900eecc67c8a6ddd343c497ac22fdd6a26e2) by Timothée Mazzucotelli).
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
## [0.6.5](https://github.com/mkdocstrings/python/releases/tag/0.6.5) - 2022-02-24
|
|
518
|
+
|
|
519
|
+
<small>[Compare with 0.6.4](https://github.com/mkdocstrings/python/compare/0.6.4...0.6.5)</small>
|
|
520
|
+
|
|
521
|
+
### Bug Fixes
|
|
522
|
+
- Don't escape signatures return annotations ([ac54bfc](https://github.com/mkdocstrings/python/commit/ac54bfc5761337aa606fb1aa6575745062ce26f8) by Timothée Mazzucotelli). [Issue #6](https://github.com/mkdocstrings/python/issues/6)
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
## [0.6.4](https://github.com/mkdocstrings/python/releases/tag/0.6.4) - 2022-02-22
|
|
526
|
+
|
|
527
|
+
<small>[Compare with 0.6.3](https://github.com/mkdocstrings/python/compare/0.6.3...0.6.4)</small>
|
|
528
|
+
|
|
529
|
+
### Bug Fixes
|
|
530
|
+
- Fix rendering of signature return annotation ([b92ba3b](https://github.com/mkdocstrings/python/commit/b92ba3b370388aa6c956bcc70ba87b7aebb91a4c) by Timothée Mazzucotelli). [Issue #4](https://github.com/mkdocstrings/python/issues/4)
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
## [0.6.3](https://github.com/mkdocstrings/python/releases/tag/0.6.3) - 2022-02-20
|
|
534
|
+
|
|
535
|
+
<small>[Compare with 0.6.2](https://github.com/mkdocstrings/python/compare/0.6.2...0.6.3)</small>
|
|
536
|
+
|
|
537
|
+
### Bug Fixes
|
|
538
|
+
- Fix examples rendering ([a06a7e3](https://github.com/mkdocstrings/python/commit/a06a7e34c7017374c5bed41f4757ed86ae64cb2e) by Timothée Mazzucotelli). [Issue mkdocstrings/griffe#46](https://github.com/mkdocstrings/griffe/issues/46)
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
## [0.6.2](https://github.com/mkdocstrings/python/releases/tag/0.6.2) - 2022-02-17
|
|
542
|
+
|
|
543
|
+
<small>[Compare with 0.6.1](https://github.com/mkdocstrings/python/compare/0.6.1...0.6.2)</small>
|
|
544
|
+
|
|
545
|
+
### Bug Fixes
|
|
546
|
+
- Catch alias resolution errors ([b734dd0](https://github.com/mkdocstrings/python/commit/b734dd0dcd72f5b985b3afce01e852c9c74e451a) by Timothée Mazzucotelli).
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
## [0.6.1](https://github.com/mkdocstrings/python/releases/tag/0.6.1) - 2022-02-17
|
|
550
|
+
|
|
551
|
+
<small>[Compare with 0.6.0](https://github.com/mkdocstrings/python/compare/0.6.0...0.6.1)</small>
|
|
552
|
+
|
|
553
|
+
### Bug Fixes
|
|
554
|
+
- Don't pop from fallback config ([bde32af](https://github.com/mkdocstrings/python/commit/bde32afb5d99539813b1884a4c735de5845f62ae) by Timothée Mazzucotelli).
|
|
555
|
+
- Fix rendering init method source when merged into class ([4a20aea](https://github.com/mkdocstrings/python/commit/4a20aeaa60f3efbcb4781a369feef3b4826ff1df) by Timothée Mazzucotelli).
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
## [0.6.0](https://github.com/mkdocstrings/python/releases/tag/0.6.0) - 2022-02-13
|
|
559
|
+
|
|
560
|
+
<small>[Compare with 0.5.4](https://github.com/mkdocstrings/python/compare/0.5.4...0.6.0)</small>
|
|
561
|
+
|
|
562
|
+
### Features
|
|
563
|
+
- Add option to merge `__init__` methods' docstrings into their classes' docstrings ([1b4d1c0](https://github.com/mkdocstrings/python/commit/1b4d1c0e9254fc51756caed3875fbc8c1da079a6) by Timothée Mazzucotelli).
|
|
564
|
+
- Support separate attribute signature ([e962b88](https://github.com/mkdocstrings/python/commit/e962b885f48570762c5bfcefc9b61e5fc1df1c70) by Timothée Mazzucotelli).
|
|
565
|
+
|
|
566
|
+
### Bug Fixes
|
|
567
|
+
- Restore full cross-refs paths on hover ([ac11970](https://github.com/mkdocstrings/python/commit/ac1197062f2e23e819f144fe74a774d504d0ac49) by Timothée Mazzucotelli).
|
|
568
|
+
- Fix rendering of labels ([52919c5](https://github.com/mkdocstrings/python/commit/52919c559378a6006bbe931423c5f03eb5883eaf) by Timothée Mazzucotelli).
|
|
569
|
+
|
|
570
|
+
### Code Refactoring
|
|
571
|
+
- Don't add trailing parentheses in functions heading when separate signature ([885696e](https://github.com/mkdocstrings/python/commit/885696e05606d07334e0428128ed688d54098da1) by Timothée Mazzucotelli).
|
|
572
|
+
- Use more explicit template debug messages ([f2122d7](https://github.com/mkdocstrings/python/commit/f2122d7fa119ed055ffe2b2bac72d2c643daca1c) by Timothée Mazzucotelli).
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
## [0.5.4](https://github.com/mkdocstrings/python/releases/tag/0.5.4) - 2022-02-13
|
|
576
|
+
|
|
577
|
+
<small>[Compare with 0.5.3](https://github.com/mkdocstrings/python/compare/0.5.3...0.5.4)</small>
|
|
578
|
+
|
|
579
|
+
### Bug Fixes
|
|
580
|
+
- Don't load additional modules during fallback ([69b8e25](https://github.com/mkdocstrings/python/commit/69b8e25cddc9e256c5edb8843592a466023aa124) by Timothée Mazzucotelli).
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
## [0.5.3](https://github.com/mkdocstrings/python/releases/tag/0.5.3) - 2022-02-08
|
|
584
|
+
|
|
585
|
+
<small>[Compare with 0.5.2](https://github.com/mkdocstrings/python/compare/0.5.2...0.5.3)</small>
|
|
586
|
+
|
|
587
|
+
### Bug Fixes
|
|
588
|
+
- Allow passing `null` as docstring style ([f526816](https://github.com/mkdocstrings/python/commit/f526816ef1d499795c647e6fe184ba91c1d41b1b) by Timothée Mazzucotelli). [Issue #2](https://github.com/mkdocstrings/python/issues/2)
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
## [0.5.2](https://github.com/mkdocstrings/python/releases/tag/0.5.2) - 2022-02-05
|
|
592
|
+
|
|
593
|
+
<small>[Compare with 0.5.1](https://github.com/mkdocstrings/python/compare/0.5.1...0.5.2)</small>
|
|
594
|
+
|
|
595
|
+
### Dependencies
|
|
596
|
+
- Require at least mkdocstrings 0.18 ([7abdda4](https://github.com/mkdocstrings/python/commit/7abdda416e25128eec06f3b15aae5058fbc7320c) by Timothée Mazzucotelli).
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
## [0.5.1](https://github.com/mkdocstrings/python/releases/tag/0.5.1) - 2022-02-03
|
|
600
|
+
|
|
601
|
+
<small>[Compare with 0.5.0](https://github.com/mkdocstrings/python/compare/0.5.0...0.5.1)</small>
|
|
602
|
+
|
|
603
|
+
### Dependencies
|
|
604
|
+
- Depend on Griffe >= 0.11.1 ([1303557](https://github.com/mkdocstrings/python/commit/1303557928a27a3d9b063baee9d698458f471357) by Timothée Mazzucotelli).
|
|
605
|
+
|
|
606
|
+
### Code Refactoring
|
|
607
|
+
- Move handler into its own module ([b787e78](https://github.com/mkdocstrings/python/commit/b787e78e31652438039775850e55ea956c22e8d0) by Timothée Mazzucotelli).
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
## [0.5.0](https://github.com/mkdocstrings/python/releases/tag/0.5.0) - 2022-02-03
|
|
611
|
+
|
|
612
|
+
<small>[Compare with 0.4.1](https://github.com/mkdocstrings/python/compare/0.4.1...0.5.0)</small>
|
|
613
|
+
|
|
614
|
+
### Features
|
|
615
|
+
- Allow changing docstring style of an object ([39240c1](https://github.com/mkdocstrings/python/commit/39240c1497dced15c03f9046138f2829fc10e139) by Timothée Mazzucotelli).
|
|
616
|
+
|
|
617
|
+
### Bug Fixes
|
|
618
|
+
- Warn if Black is not installed when formatting signature ([b848277](https://github.com/mkdocstrings/python/commit/b84827789b2bf66a4b76ff63a514ec6ba98cae68) by Timothée Mazzucotelli).
|
|
619
|
+
- Fix missing default for `docstring_section_style` option ([774988e](https://github.com/mkdocstrings/python/commit/774988ef06a9bf3446949da63611ad7bc5a712fc) by Timothée Mazzucotelli).
|
|
620
|
+
|
|
621
|
+
### Code Refactoring
|
|
622
|
+
- Change to new way of stripping paragraphs ([33d4594](https://github.com/mkdocstrings/python/commit/33d45945bf8ffce2435a6b3749795397fa7c3fc8) by Timothée Mazzucotelli).
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
## [0.4.1](https://github.com/mkdocstrings/python/releases/tag/0.4.1) - 2022-02-01
|
|
626
|
+
|
|
627
|
+
<small>[Compare with 0.4.0](https://github.com/mkdocstrings/python/compare/0.4.0...0.4.1)</small>
|
|
628
|
+
|
|
629
|
+
### Bug Fixes
|
|
630
|
+
- Fix docstring admonitions rendering ([a24ae2e](https://github.com/mkdocstrings/python/commit/a24ae2e95f4c0451a44037120451cf06c973ba65) by Timothée Mazzucotelli).
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
## [0.4.0](https://github.com/mkdocstrings/python/releases/tag/0.4.0) - 2022-02-01
|
|
634
|
+
|
|
635
|
+
<small>[Compare with 0.3.0](https://github.com/mkdocstrings/python/compare/0.3.0...0.4.0)</small>
|
|
636
|
+
|
|
637
|
+
### Code Refactoring
|
|
638
|
+
- Use the new `mkdocstrings_handlers` namespace ([23c9023](https://github.com/mkdocstrings/python/commit/23c9023780535251778077cd7d957c0067ecb0dc) by Timothée Mazzucotelli).
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
## [0.3.0](https://github.com/mkdocstrings/python/releases/tag/0.3.0) - 2022-01-14
|
|
642
|
+
|
|
643
|
+
<small>[Compare with 0.2.0](https://github.com/mkdocstrings/python/compare/0.2.0...0.3.0)</small>
|
|
644
|
+
|
|
645
|
+
### Features
|
|
646
|
+
- Support griffe 0.10 ([28061de](https://github.com/mkdocstrings/python/commit/28061de20094c510f27bb375b2e1dc44a699809d) by Timothée Mazzucotelli).
|
|
647
|
+
|
|
648
|
+
### Dependencies
|
|
649
|
+
- Require griffe 0.10 ([cfbd7bb](https://github.com/mkdocstrings/python/commit/cfbd7bb4761691ef36100962c775ed1d0a247514) by Timothée Mazzucotelli).
|
|
650
|
+
|
|
651
|
+
### Code Refactoring
|
|
652
|
+
- Use new logger patching utility ([4cdb292](https://github.com/mkdocstrings/python/commit/4cdb2921b3a9292db3ef0663c63f148a4eec3966) by Timothée Mazzucotelli).
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
## [0.2.0](https://github.com/mkdocstrings/python/releases/tag/0.2.0) - 2021-12-28
|
|
656
|
+
|
|
657
|
+
<small>[Compare with 0.1.0](https://github.com/mkdocstrings/python/compare/0.1.0...0.2.0)</small>
|
|
658
|
+
|
|
659
|
+
### Dependencies
|
|
660
|
+
- Depend on griffe >= 0.7.1 ([34f7ebd](https://github.com/mkdocstrings/python/commit/34f7ebd41f3ebda025ad87e3b52a7226fcb93720) by Timothée Mazzucotelli).
|
|
661
|
+
- Upgrade griffe, no upper bound ([8f0aa42](https://github.com/mkdocstrings/python/commit/8f0aa42eed07424a1377708897d92f9894f4abdb) by Timothée Mazzucotelli).
|
|
662
|
+
|
|
663
|
+
### Features
|
|
664
|
+
- Add `show_signature` rendering option ([0f07c2e](https://github.com/mkdocstrings/python/commit/0f07c2e51a51a56eeb5d32fdf05dbed7243f0bc5) by Will Da Silva).
|
|
665
|
+
|
|
666
|
+
### Bug Fixes
|
|
667
|
+
- Fix templates for named docstring elements ([47868a1](https://github.com/mkdocstrings/python/commit/47868a143bf2c462abd5ad85bd0ab8dca7bc5f82) by Timothée Mazzucotelli).
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
## [0.1.0](https://github.com/mkdocstrings/python/releases/tag/0.1.0) - 2021-12-19
|
|
671
|
+
|
|
672
|
+
<small>[Compare with first commit](https://github.com/mkdocstrings/python/compare/0032f18c9f902c3e75e0e00114ca8fa6a810c8f5...0.1.0)</small>
|
|
673
|
+
|
|
674
|
+
### Features
|
|
675
|
+
- Implement handler and add templates ([dbb580a](https://github.com/mkdocstrings/python/commit/dbb580aa79f6b2f8a089c80bdc67d0f7457c2d30) by Timothée Mazzucotelli).
|
|
676
|
+
|
|
677
|
+
### Bug Fixes
|
|
678
|
+
- Fix separate signature feature ([da6e81c](https://github.com/mkdocstrings/python/commit/da6e81c897899f09e1dae7bb8930ce6782aeb306) by Timothée Mazzucotelli).
|
|
679
|
+
- Fix signature template (parameters annotations) ([b34ead0](https://github.com/mkdocstrings/python/commit/b34ead008773880fd8d1d7a2a41768ec27820520) by Timothée Mazzucotelli).
|
|
680
|
+
- Only show source when present ([c270d68](https://github.com/mkdocstrings/python/commit/c270d68c9e17204606ae12a2159c04563a18ec2b) by Timothée Mazzucotelli).
|
|
681
|
+
|
|
682
|
+
### Code Refactoring
|
|
683
|
+
- Return all known anchors ([9bbfe14](https://github.com/mkdocstrings/python/commit/9bbfe1442e2aab28bd6fb2618c943d3f698750ab) by Timothée Mazzucotelli).
|
|
684
|
+
- Update for griffe 0.4.0 ([831aabb](https://github.com/mkdocstrings/python/commit/831aabb135db7e75729954adc675af6379f58e24) by Timothée Mazzucotelli).
|