mkdocstrings-python 1.10.9__tar.gz → 1.11.0__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.9 → mkdocstrings_python-1.11.0}/CHANGELOG.md +8 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/PKG-INFO +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/pyproject.toml +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/handler.py +1 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/rendering.py +58 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja +2 -2
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja +3 -3
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja +3 -3
- mkdocstrings_python-1.11.0/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja +55 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html.jinja +1 -1
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html.jinja +1 -1
- mkdocstrings_python-1.10.9/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja +0 -53
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/CODE_OF_CONDUCT.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/CONTRIBUTING.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/LICENSE +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/README.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/black.toml +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/coverage.ini +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/git-changelog.toml +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/mypy.ini +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/pytest.ini +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/ruff.toml +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/vscode/launch.json +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/vscode/settings.json +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/config/vscode/tasks.json +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/devdeps.txt +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/.glossary.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/.overrides/main.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/.overrides/partials/comments.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/changelog.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/code_of_conduct.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/contributing.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/credits.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/css/insiders.css +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/css/material.css +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/css/mkdocstrings.css +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/index.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/insiders/changelog.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/insiders/goals.yml +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/insiders/index.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/insiders/installation.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/js/feedback.js +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/js/insiders.js +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/license.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/logo.png +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/schema.json +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/configuration/docstrings.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/configuration/general.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/configuration/headings.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/configuration/members.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/configuration/signatures.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/customization.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/docstrings/google.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/docstrings/numpy.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/docstrings/sphinx.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/extensions.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/docs/usage/index.md +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/duties.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/mkdocs.yml +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/scripts/.cache/plugin/git-committers/page-authors.json +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/scripts/gen_credits.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/scripts/gen_ref_nav.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/scripts/insiders.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/scripts/make +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/__init__.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/debug.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/py.typed +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/children.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/children.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/class.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/function.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/language.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/module.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/module.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/classes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/functions.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/modules.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/attribute.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/attribute.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/children.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/children.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/class.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/class.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/docstring.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/expression.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/expression.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/function.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/function.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/labels.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/labels.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/language.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/en.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/module.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/module.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/signature.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/signature.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/style.css +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/classes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/classes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/functions.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/functions.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/modules.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary/modules.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/summary.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/language.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/tests/__init__.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/tests/conftest.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/tests/test_handler.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/tests/test_rendering.py +0 -0
- {mkdocstrings_python-1.10.9 → mkdocstrings_python-1.11.0}/tests/test_themes.py +0 -0
|
@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
|
5
5
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
7
|
<!-- insertion marker -->
|
|
8
|
+
## [1.11.0](https://github.com/mkdocstrings/python/releases/tag/1.11.0) - 2024-09-03
|
|
9
|
+
|
|
10
|
+
<small>[Compare with 1.10.9](https://github.com/mkdocstrings/python/compare/1.10.9...1.11.0)</small>
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
- Hook into autorefs to provide context around cross-ref errors ([bb4be5b](https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165) by Timothée Mazzucotelli).
|
|
15
|
+
|
|
8
16
|
## [1.10.9](https://github.com/mkdocstrings/python/releases/tag/1.10.9) - 2024-08-30
|
|
9
17
|
|
|
10
18
|
<small>[Compare with 1.10.8](https://github.com/mkdocstrings/python/compare/1.10.8...1.10.9)</small>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mkdocstrings-python
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.11.0
|
|
4
4
|
Summary: A Python handler for mkdocstrings.
|
|
5
5
|
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
|
|
6
6
|
License: ISC
|
|
@@ -28,8 +28,8 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
|
|
|
28
28
|
Project-URL: Gitter, https://gitter.im/mkdocstrings/python
|
|
29
29
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
30
30
|
Requires-Python: >=3.8
|
|
31
|
-
Requires-Dist: mkdocstrings>=0.
|
|
32
|
-
Requires-Dist: mkdocs-autorefs>=1.
|
|
31
|
+
Requires-Dist: mkdocstrings>=0.26
|
|
32
|
+
Requires-Dist: mkdocs-autorefs>=1.2
|
|
33
33
|
Requires-Dist: griffe>=0.49
|
|
34
34
|
Description-Content-Type: text/markdown
|
|
35
35
|
|
|
@@ -32,11 +32,11 @@ classifiers = [
|
|
|
32
32
|
"Typing :: Typed",
|
|
33
33
|
]
|
|
34
34
|
dependencies = [
|
|
35
|
-
"mkdocstrings>=0.
|
|
36
|
-
"mkdocs-autorefs>=1.
|
|
35
|
+
"mkdocstrings>=0.26",
|
|
36
|
+
"mkdocs-autorefs>=1.2",
|
|
37
37
|
"griffe>=0.49",
|
|
38
38
|
]
|
|
39
|
-
version = "1.
|
|
39
|
+
version = "1.11.0"
|
|
40
40
|
|
|
41
41
|
[project.license]
|
|
42
42
|
text = "ISC"
|
|
@@ -426,6 +426,7 @@ class PythonHandler(BaseHandler):
|
|
|
426
426
|
self.env.filters["as_functions_section"] = rendering.do_as_functions_section
|
|
427
427
|
self.env.filters["as_classes_section"] = rendering.do_as_classes_section
|
|
428
428
|
self.env.filters["as_modules_section"] = rendering.do_as_modules_section
|
|
429
|
+
self.env.globals["AutorefsHook"] = rendering.AutorefsHook
|
|
429
430
|
self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()
|
|
430
431
|
|
|
431
432
|
def get_anchors(self, data: CollectorItem) -> tuple[str, ...]: # noqa: D102 (ignore missing docstring)
|
|
@@ -22,6 +22,7 @@ from griffe import (
|
|
|
22
22
|
)
|
|
23
23
|
from jinja2 import TemplateNotFound, pass_context, pass_environment
|
|
24
24
|
from markupsafe import Markup
|
|
25
|
+
from mkdocs_autorefs.references import AutorefsHookInterface
|
|
25
26
|
from mkdocstrings.loggers import get_logger
|
|
26
27
|
|
|
27
28
|
if TYPE_CHECKING:
|
|
@@ -571,3 +572,60 @@ def do_as_modules_section(
|
|
|
571
572
|
A modules docstring section.
|
|
572
573
|
"""
|
|
573
574
|
return DocstringSectionModules([])
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
class AutorefsHook(AutorefsHookInterface):
|
|
578
|
+
"""Autorefs hook.
|
|
579
|
+
|
|
580
|
+
With this hook, we're able to add context to autorefs (cross-references),
|
|
581
|
+
such as originating file path and line number, to improve error reporting.
|
|
582
|
+
"""
|
|
583
|
+
|
|
584
|
+
def __init__(self, current_object: Object | Alias, config: dict[str, Any]) -> None:
|
|
585
|
+
"""Initialize the hook.
|
|
586
|
+
|
|
587
|
+
Parameters:
|
|
588
|
+
current_object: The object being rendered.
|
|
589
|
+
config: The configuration dictionary.
|
|
590
|
+
"""
|
|
591
|
+
self.current_object = current_object
|
|
592
|
+
self.config = config
|
|
593
|
+
|
|
594
|
+
def expand_identifier(self, identifier: str) -> str:
|
|
595
|
+
"""Expand an identifier.
|
|
596
|
+
|
|
597
|
+
Parameters:
|
|
598
|
+
identifier: The identifier to expand.
|
|
599
|
+
|
|
600
|
+
Returns:
|
|
601
|
+
The expanded identifier.
|
|
602
|
+
"""
|
|
603
|
+
return identifier
|
|
604
|
+
|
|
605
|
+
def get_context(self) -> AutorefsHookInterface.Context:
|
|
606
|
+
"""Get the context for the current object.
|
|
607
|
+
|
|
608
|
+
Returns:
|
|
609
|
+
The context.
|
|
610
|
+
"""
|
|
611
|
+
role = {
|
|
612
|
+
"attribute": "data" if self.current_object.parent and self.current_object.parent.is_module else "attr",
|
|
613
|
+
"class": "class",
|
|
614
|
+
"function": "meth" if self.current_object.parent and self.current_object.parent.is_class else "func",
|
|
615
|
+
"module": "mod",
|
|
616
|
+
}.get(self.current_object.kind.value.lower(), "obj")
|
|
617
|
+
origin = self.current_object.path
|
|
618
|
+
try:
|
|
619
|
+
filepath = self.current_object.docstring.parent.filepath # type: ignore[union-attr]
|
|
620
|
+
lineno = self.current_object.docstring.lineno or 0 # type: ignore[union-attr]
|
|
621
|
+
except AttributeError:
|
|
622
|
+
filepath = self.current_object.filepath
|
|
623
|
+
lineno = 0
|
|
624
|
+
|
|
625
|
+
return AutorefsHookInterface.Context(
|
|
626
|
+
domain="py",
|
|
627
|
+
role=role,
|
|
628
|
+
origin=origin,
|
|
629
|
+
filepath=str(filepath),
|
|
630
|
+
lineno=lineno,
|
|
631
|
+
)
|
|
@@ -15,6 +15,6 @@ Context:
|
|
|
15
15
|
{% endblock logs %}
|
|
16
16
|
|
|
17
17
|
<details class="{{ section.value.kind }}" open>
|
|
18
|
-
<summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</summary>
|
|
19
|
-
{{ section.value.contents|convert_markdown(heading_level, html_id) }}
|
|
18
|
+
<summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True, autoref_hook=autoref_hook) }}</summary>
|
|
19
|
+
{{ section.value.contents|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
20
20
|
</details>
|
|
@@ -43,7 +43,7 @@ Context:
|
|
|
43
43
|
</td>
|
|
44
44
|
<td>
|
|
45
45
|
<div class="doc-md-description">
|
|
46
|
-
{{ attribute.description|convert_markdown(heading_level, html_id) }}
|
|
46
|
+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
47
47
|
</div>
|
|
48
48
|
</td>
|
|
49
49
|
</tr>
|
|
@@ -66,7 +66,7 @@ Context:
|
|
|
66
66
|
{% endif %}
|
|
67
67
|
–
|
|
68
68
|
<div class="doc-md-description">
|
|
69
|
-
{{ attribute.description|convert_markdown(heading_level, html_id) }}
|
|
69
|
+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
70
70
|
</div>
|
|
71
71
|
</li>
|
|
72
72
|
{% endfor %}
|
|
@@ -88,7 +88,7 @@ Context:
|
|
|
88
88
|
<td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
|
|
89
89
|
<td class="doc-attribute-details">
|
|
90
90
|
<div class="doc-md-description">
|
|
91
|
-
{{ attribute.description|convert_markdown(heading_level, html_id) }}
|
|
91
|
+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
92
92
|
</div>
|
|
93
93
|
<p>
|
|
94
94
|
{% if attribute.annotation %}
|
|
@@ -35,7 +35,7 @@ Context:
|
|
|
35
35
|
<td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
|
|
36
36
|
<td>
|
|
37
37
|
<div class="doc-md-description">
|
|
38
|
-
{{ class.description|convert_markdown(heading_level, html_id) }}
|
|
38
|
+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
39
39
|
</div>
|
|
40
40
|
</td>
|
|
41
41
|
</tr>
|
|
@@ -53,7 +53,7 @@ Context:
|
|
|
53
53
|
<b><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></b>
|
|
54
54
|
–
|
|
55
55
|
<div class="doc-md-description">
|
|
56
|
-
{{ class.description|convert_markdown(heading_level, html_id) }}
|
|
56
|
+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
57
57
|
</div>
|
|
58
58
|
</li>
|
|
59
59
|
{% endfor %}
|
|
@@ -75,7 +75,7 @@ Context:
|
|
|
75
75
|
<td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
|
|
76
76
|
<td class="doc-class-details">
|
|
77
77
|
<div class="doc-md-description">
|
|
78
|
-
{{ class.description|convert_markdown(heading_level, html_id) }}
|
|
78
|
+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
79
79
|
</div>
|
|
80
80
|
</td>
|
|
81
81
|
</tr>
|
|
@@ -21,7 +21,7 @@ Context:
|
|
|
21
21
|
<p><span class="doc-section-title">{{ section.title or lang.t("Examples:") }}</span></p>
|
|
22
22
|
{% for section_type, sub_section in section.value %}
|
|
23
23
|
{% if section_type.value == "text" %}
|
|
24
|
-
{{ sub_section|convert_markdown(heading_level, html_id) }}
|
|
24
|
+
{{ sub_section|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
25
25
|
{% elif section_type.value == "examples" %}
|
|
26
26
|
{{ sub_section|highlight(language="pycon", linenums=False) }}
|
|
27
27
|
{% endif %}
|
|
@@ -36,7 +36,7 @@ Context:
|
|
|
36
36
|
<td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
|
|
37
37
|
<td>
|
|
38
38
|
<div class="doc-md-description">
|
|
39
|
-
{{ function.description|convert_markdown(heading_level, html_id) }}
|
|
39
|
+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
40
40
|
</div>
|
|
41
41
|
</td>
|
|
42
42
|
</tr>
|
|
@@ -56,7 +56,7 @@ Context:
|
|
|
56
56
|
<b><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></b>
|
|
57
57
|
–
|
|
58
58
|
<div class="doc-md-description">
|
|
59
|
-
{{ function.description|convert_markdown(heading_level, html_id) }}
|
|
59
|
+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
60
60
|
</div>
|
|
61
61
|
</li>
|
|
62
62
|
{% endif %}
|
|
@@ -80,7 +80,7 @@ Context:
|
|
|
80
80
|
<td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
|
|
81
81
|
<td class="doc-function-details">
|
|
82
82
|
<div class="doc-md-description">
|
|
83
|
-
{{ function.description|convert_markdown(heading_level, html_id) }}
|
|
83
|
+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
84
84
|
</div>
|
|
85
85
|
</td>
|
|
86
86
|
</tr>
|
|
@@ -35,7 +35,7 @@ Context:
|
|
|
35
35
|
<td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
|
|
36
36
|
<td>
|
|
37
37
|
<div class="doc-md-description">
|
|
38
|
-
{{ module.description|convert_markdown(heading_level, html_id) }}
|
|
38
|
+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
39
39
|
</div>
|
|
40
40
|
</td>
|
|
41
41
|
</tr>
|
|
@@ -53,7 +53,7 @@ Context:
|
|
|
53
53
|
<b><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></b>
|
|
54
54
|
–
|
|
55
55
|
<div class="doc-md-description">
|
|
56
|
-
{{ module.description|convert_markdown(heading_level, html_id) }}
|
|
56
|
+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
57
57
|
</div>
|
|
58
58
|
</li>
|
|
59
59
|
{% endfor %}
|
|
@@ -75,7 +75,7 @@ Context:
|
|
|
75
75
|
<td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
|
|
76
76
|
<td class="doc-module-details">
|
|
77
77
|
<div class="doc-md-description">
|
|
78
|
-
{{ module.description|convert_markdown(heading_level, html_id) }}
|
|
78
|
+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
79
79
|
</div>
|
|
80
80
|
</td>
|
|
81
81
|
</tr>
|
|
@@ -43,7 +43,7 @@ Context:
|
|
|
43
43
|
</td>
|
|
44
44
|
<td>
|
|
45
45
|
<div class="doc-md-description">
|
|
46
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
46
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
47
47
|
</div>
|
|
48
48
|
</td>
|
|
49
49
|
</tr>
|
|
@@ -66,7 +66,7 @@ Context:
|
|
|
66
66
|
{% endif %}
|
|
67
67
|
–
|
|
68
68
|
<div class="doc-md-description">
|
|
69
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
69
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
70
70
|
</div>
|
|
71
71
|
</li>
|
|
72
72
|
{% endfor %}
|
|
@@ -88,7 +88,7 @@ Context:
|
|
|
88
88
|
<td><code>{{ parameter.name }}</code></td>
|
|
89
89
|
<td class="doc-param-details">
|
|
90
90
|
<div class="doc-md-description">
|
|
91
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
91
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
92
92
|
</div>
|
|
93
93
|
<p>
|
|
94
94
|
{% if parameter.annotation %}
|
|
@@ -44,7 +44,7 @@ Context:
|
|
|
44
44
|
</td>
|
|
45
45
|
<td>
|
|
46
46
|
<div class="doc-md-description">
|
|
47
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
47
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
48
48
|
</div>
|
|
49
49
|
</td>
|
|
50
50
|
<td>
|
|
@@ -81,7 +81,7 @@ Context:
|
|
|
81
81
|
{% endif %}
|
|
82
82
|
–
|
|
83
83
|
<div class="doc-md-description">
|
|
84
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
84
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
85
85
|
</div>
|
|
86
86
|
</li>
|
|
87
87
|
{% endfor %}
|
|
@@ -103,7 +103,7 @@ Context:
|
|
|
103
103
|
<td><code>{{ parameter.name }}</code></td>
|
|
104
104
|
<td class="doc-param-details">
|
|
105
105
|
<div class="doc-md-description">
|
|
106
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
106
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
107
107
|
</div>
|
|
108
108
|
<p>
|
|
109
109
|
{% if parameter.annotation %}
|
|
@@ -41,7 +41,7 @@ Context:
|
|
|
41
41
|
</td>
|
|
42
42
|
<td>
|
|
43
43
|
<div class="doc-md-description">
|
|
44
|
-
{{ raises.description|convert_markdown(heading_level, html_id) }}
|
|
44
|
+
{{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
45
45
|
</div>
|
|
46
46
|
</td>
|
|
47
47
|
</tr>
|
|
@@ -63,7 +63,7 @@ Context:
|
|
|
63
63
|
–
|
|
64
64
|
{% endif %}
|
|
65
65
|
<div class="doc-md-description">
|
|
66
|
-
{{ raises.description|convert_markdown(heading_level, html_id) }}
|
|
66
|
+
{{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
67
67
|
</div>
|
|
68
68
|
</li>
|
|
69
69
|
{% endfor %}
|
|
@@ -91,7 +91,7 @@ Context:
|
|
|
91
91
|
</td>
|
|
92
92
|
<td class="doc-raises-details">
|
|
93
93
|
<div class="doc-md-description">
|
|
94
|
-
{{ raises.description|convert_markdown(heading_level, html_id) }}
|
|
94
|
+
{{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
95
95
|
</div>
|
|
96
96
|
</td>
|
|
97
97
|
</tr>
|
|
@@ -44,7 +44,7 @@ Context:
|
|
|
44
44
|
</td>
|
|
45
45
|
<td>
|
|
46
46
|
<div class="doc-md-description">
|
|
47
|
-
{{ receives.description|convert_markdown(heading_level, html_id) }}
|
|
47
|
+
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
48
48
|
</div>
|
|
49
49
|
</td>
|
|
50
50
|
</tr>
|
|
@@ -69,7 +69,7 @@ Context:
|
|
|
69
69
|
{% endif %}
|
|
70
70
|
–
|
|
71
71
|
<div class="doc-md-description">
|
|
72
|
-
{{ receives.description|convert_markdown(heading_level, html_id) }}
|
|
72
|
+
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
73
73
|
</div>
|
|
74
74
|
</li>
|
|
75
75
|
{% endfor %}
|
|
@@ -101,7 +101,7 @@ Context:
|
|
|
101
101
|
</td>
|
|
102
102
|
<td class="doc-receives-details">
|
|
103
103
|
<div class="doc-md-description">
|
|
104
|
-
{{ receives.description|convert_markdown(heading_level, html_id) }}
|
|
104
|
+
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
105
105
|
</div>
|
|
106
106
|
{% if receives.name and receives.annotation %}
|
|
107
107
|
<p>
|
|
@@ -44,7 +44,7 @@ Context:
|
|
|
44
44
|
</td>
|
|
45
45
|
<td>
|
|
46
46
|
<div class="doc-md-description">
|
|
47
|
-
{{ returns.description|convert_markdown(heading_level, html_id) }}
|
|
47
|
+
{{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
48
48
|
</div>
|
|
49
49
|
</td>
|
|
50
50
|
</tr>
|
|
@@ -69,7 +69,7 @@ Context:
|
|
|
69
69
|
{% endif %}
|
|
70
70
|
–
|
|
71
71
|
<div class="doc-md-description">
|
|
72
|
-
{{ returns.description|convert_markdown(heading_level, html_id) }}
|
|
72
|
+
{{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
73
73
|
</div>
|
|
74
74
|
</li>
|
|
75
75
|
{% endfor %}
|
|
@@ -101,7 +101,7 @@ Context:
|
|
|
101
101
|
</td>
|
|
102
102
|
<td class="doc-returns-details">
|
|
103
103
|
<div class="doc-md-description">
|
|
104
|
-
{{ returns.description|convert_markdown(heading_level, html_id) }}
|
|
104
|
+
{{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
105
105
|
</div>
|
|
106
106
|
{% if returns.name and returns.annotation %}
|
|
107
107
|
<p>
|
|
@@ -41,7 +41,7 @@ Context:
|
|
|
41
41
|
</td>
|
|
42
42
|
<td>
|
|
43
43
|
<div class="doc-md-description">
|
|
44
|
-
{{ warns.description|convert_markdown(heading_level, html_id) }}
|
|
44
|
+
{{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
45
45
|
</div>
|
|
46
46
|
</td>
|
|
47
47
|
</tr>
|
|
@@ -63,7 +63,7 @@ Context:
|
|
|
63
63
|
–
|
|
64
64
|
{% endif %}
|
|
65
65
|
<div class="doc-md-description">
|
|
66
|
-
{{ warns.description|convert_markdown(heading_level, html_id) }}
|
|
66
|
+
{{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
67
67
|
</div>
|
|
68
68
|
</li>
|
|
69
69
|
{% endfor %}
|
|
@@ -91,7 +91,7 @@ Context:
|
|
|
91
91
|
</td>
|
|
92
92
|
<td class="doc-warns-details">
|
|
93
93
|
<div class="doc-md-description">
|
|
94
|
-
{{ warns.description|convert_markdown(heading_level, html_id) }}
|
|
94
|
+
{{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
95
95
|
</div>
|
|
96
96
|
</td>
|
|
97
97
|
</tr>
|
|
@@ -44,7 +44,7 @@ Context:
|
|
|
44
44
|
</td>
|
|
45
45
|
<td>
|
|
46
46
|
<div class="doc-md-description">
|
|
47
|
-
{{ yields.description|convert_markdown(heading_level, html_id) }}
|
|
47
|
+
{{ yields.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
48
48
|
</div>
|
|
49
49
|
</td>
|
|
50
50
|
</tr>
|
|
@@ -69,7 +69,7 @@ Context:
|
|
|
69
69
|
{% endif %}
|
|
70
70
|
–
|
|
71
71
|
<div class="doc-md-description">
|
|
72
|
-
{{ yields.description|convert_markdown(heading_level, html_id) }}
|
|
72
|
+
{{ yields.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
73
73
|
</div>
|
|
74
74
|
</li>
|
|
75
75
|
{% endfor %}
|
|
@@ -101,7 +101,7 @@ Context:
|
|
|
101
101
|
</td>
|
|
102
102
|
<td class="doc-yields-details">
|
|
103
103
|
<div class="doc-md-description">
|
|
104
|
-
{{ yields.description|convert_markdown(heading_level, html_id) }}
|
|
104
|
+
{{ yields.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
105
105
|
</div>
|
|
106
106
|
{% if yields.name and yields.annotation %}
|
|
107
107
|
<p>
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{#- Template for docstrings.
|
|
2
|
+
|
|
3
|
+
This template renders Python docstrings.
|
|
4
|
+
Griffe parses docstrings into a list of sections, each with a `kind` and a `value`.
|
|
5
|
+
This template can then iterate on these sections and render them according to the configuration.
|
|
6
|
+
|
|
7
|
+
Context:
|
|
8
|
+
docstring_sections (list[griffe.DocstringSection]): The list of docstring sections.
|
|
9
|
+
config (dict): The configuration dictionary.
|
|
10
|
+
heading_level (int): The heading level to use for Markdown conversion.
|
|
11
|
+
html_id (str): The HTML ID to use for Markdown conversion.
|
|
12
|
+
-#}
|
|
13
|
+
|
|
14
|
+
{% if docstring_sections %}
|
|
15
|
+
{% block logs scoped %}
|
|
16
|
+
{#- Logging block.
|
|
17
|
+
|
|
18
|
+
This block can be used to log debug messages, deprecation messages, warnings, etc.
|
|
19
|
+
-#}
|
|
20
|
+
{{ log.debug("Rendering docstring") }}
|
|
21
|
+
{% endblock logs %}
|
|
22
|
+
{% with autoref_hook = AutorefsHook(obj, config) %}
|
|
23
|
+
{% for section in docstring_sections %}
|
|
24
|
+
{% if config.show_docstring_description and section.kind.value == "text" %}
|
|
25
|
+
{{ section.value|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
26
|
+
{% elif config.show_docstring_attributes and section.kind.value == "attributes" %}
|
|
27
|
+
{% include "docstring/attributes"|get_template with context %}
|
|
28
|
+
{% elif config.show_docstring_functions and section.kind.value == "functions" %}
|
|
29
|
+
{% include "docstring/functions"|get_template with context %}
|
|
30
|
+
{% elif config.show_docstring_classes and section.kind.value == "classes" %}
|
|
31
|
+
{% include "docstring/classes"|get_template with context %}
|
|
32
|
+
{% elif config.show_docstring_modules and section.kind.value == "modules" %}
|
|
33
|
+
{% include "docstring/modules"|get_template with context %}
|
|
34
|
+
{% elif config.show_docstring_parameters and section.kind.value == "parameters" %}
|
|
35
|
+
{% include "docstring/parameters"|get_template with context %}
|
|
36
|
+
{% elif config.show_docstring_other_parameters and section.kind.value == "other parameters" %}
|
|
37
|
+
{% include "docstring/other_parameters"|get_template with context %}
|
|
38
|
+
{% elif config.show_docstring_raises and section.kind.value == "raises" %}
|
|
39
|
+
{% include "docstring/raises"|get_template with context %}
|
|
40
|
+
{% elif config.show_docstring_warns and section.kind.value == "warns" %}
|
|
41
|
+
{% include "docstring/warns"|get_template with context %}
|
|
42
|
+
{% elif config.show_docstring_yields and section.kind.value == "yields" %}
|
|
43
|
+
{% include "docstring/yields"|get_template with context %}
|
|
44
|
+
{% elif config.show_docstring_receives and section.kind.value == "receives" %}
|
|
45
|
+
{% include "docstring/receives"|get_template with context %}
|
|
46
|
+
{% elif config.show_docstring_returns and section.kind.value == "returns" %}
|
|
47
|
+
{% include "docstring/returns"|get_template with context %}
|
|
48
|
+
{% elif config.show_docstring_examples and section.kind.value == "examples" %}
|
|
49
|
+
{% include "docstring/examples"|get_template with context %}
|
|
50
|
+
{% elif config.show_docstring_description and section.kind.value == "admonition" %}
|
|
51
|
+
{% include "docstring/admonition"|get_template with context %}
|
|
52
|
+
{% endif %}
|
|
53
|
+
{% endfor %}
|
|
54
|
+
{% endwith %}
|
|
55
|
+
{% endif %}
|
|
@@ -38,7 +38,7 @@ Context:
|
|
|
38
38
|
{% endif %}
|
|
39
39
|
–
|
|
40
40
|
<div class="doc-md-description">
|
|
41
|
-
{{ attribute.description|convert_markdown(heading_level, html_id) }}
|
|
41
|
+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
42
42
|
</div>
|
|
43
43
|
</li>
|
|
44
44
|
{% endfor %}
|
|
@@ -38,7 +38,7 @@ Context:
|
|
|
38
38
|
{% endif %}
|
|
39
39
|
–
|
|
40
40
|
<div class="doc-md-description">
|
|
41
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
41
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
42
42
|
</div>
|
|
43
43
|
</li>
|
|
44
44
|
{% endfor %}
|
|
@@ -43,7 +43,7 @@ Context:
|
|
|
43
43
|
{% endif %}
|
|
44
44
|
–
|
|
45
45
|
<div class="doc-md-description">
|
|
46
|
-
{{ parameter.description|convert_markdown(heading_level, html_id) }}
|
|
46
|
+
{{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
47
47
|
</div>
|
|
48
48
|
</li>
|
|
49
49
|
{% endfor %}
|
|
@@ -37,7 +37,7 @@ Context:
|
|
|
37
37
|
{% endif %}
|
|
38
38
|
–
|
|
39
39
|
<div class="doc-md-description">
|
|
40
|
-
{{ raises.description|convert_markdown(heading_level, html_id) }}
|
|
40
|
+
{{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
41
41
|
</div>
|
|
42
42
|
</li>
|
|
43
43
|
{% endfor %}
|
|
@@ -40,7 +40,7 @@ Context:
|
|
|
40
40
|
{% endif %}
|
|
41
41
|
–
|
|
42
42
|
<div class="doc-md-description">
|
|
43
|
-
{{ receives.description|convert_markdown(heading_level, html_id) }}
|
|
43
|
+
{{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
44
44
|
</div>
|
|
45
45
|
</li>
|
|
46
46
|
{% endfor %}
|
|
@@ -40,7 +40,7 @@ Context:
|
|
|
40
40
|
{% endif %}
|
|
41
41
|
–
|
|
42
42
|
<div class="doc-md-description">
|
|
43
|
-
{{ returns.description|convert_markdown(heading_level, html_id) }}
|
|
43
|
+
{{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
44
44
|
</div>
|
|
45
45
|
</li>
|
|
46
46
|
{% endfor %}
|
|
@@ -37,7 +37,7 @@ Context:
|
|
|
37
37
|
{% endif %}
|
|
38
38
|
–
|
|
39
39
|
<div class="doc-md-description">
|
|
40
|
-
{{ warns.description|convert_markdown(heading_level, html_id) }}
|
|
40
|
+
{{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
41
41
|
</div>
|
|
42
42
|
</li>
|
|
43
43
|
{% endfor %}
|
|
@@ -40,7 +40,7 @@ Context:
|
|
|
40
40
|
{% endif %}
|
|
41
41
|
–
|
|
42
42
|
<div class="doc-md-description">
|
|
43
|
-
{{ yields.description|convert_markdown(heading_level, html_id) }}
|
|
43
|
+
{{ yields.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
|
|
44
44
|
</div>
|
|
45
45
|
</li>
|
|
46
46
|
{% endfor %}
|