From 1baae3a355088a3ce8ec0c1f129539a14e4c922e Mon Sep 17 00:00:00 2001 From: Testing Git Date: Sun, 15 Dec 2024 15:46:21 +0000 Subject: [PATCH] Deployed 85f19df with MkDocs version: 1.6.1 --- .../material/docstring/attributes.html.jinja | 90 +++++++++++++++++ .../material/docstring/parameters.html.jinja | 98 +++++++++++++++++++ .../material/docstring/raises.html.jinja | 72 ++++++++++++++ .../material/docstring/returns.html.jinja | 94 ++++++++++++++++++ reference/api/bumpversion/aliases/index.html | 4 +- reference/api/bumpversion/autocast/index.html | 4 +- reference/api/bumpversion/bump/index.html | 4 +- reference/api/bumpversion/cli/index.html | 4 +- .../api/bumpversion/config/create/index.html | 4 +- .../api/bumpversion/config/files/index.html | 4 +- .../config/files_legacy/index.html | 4 +- reference/api/bumpversion/config/index.html | 4 +- .../api/bumpversion/config/models/index.html | 4 +- .../api/bumpversion/config/utils/index.html | 4 +- reference/api/bumpversion/context/index.html | 4 +- .../api/bumpversion/exceptions/index.html | 4 +- reference/api/bumpversion/files/index.html | 4 +- reference/api/bumpversion/hooks/index.html | 4 +- .../bumpversion/indented_logger/index.html | 4 +- reference/api/bumpversion/index.html | 4 +- reference/api/bumpversion/scm/index.html | 4 +- reference/api/bumpversion/show/index.html | 4 +- reference/api/bumpversion/ui/index.html | 4 +- reference/api/bumpversion/utils/index.html | 4 +- .../versioning/conventions/index.html | 4 +- .../versioning/functions/index.html | 4 +- .../api/bumpversion/versioning/index.html | 4 +- .../bumpversion/versioning/models/index.html | 4 +- .../versioning/serialization/index.html | 4 +- .../versioning/version_config/index.html | 4 +- .../api/bumpversion/visualize/index.html | 4 +- .../api/bumpversion/yaml_dump/index.html | 4 +- reference/index.html | 6 +- 33 files changed, 413 insertions(+), 59 deletions(-) create mode 100644 mkdocstrings/python/material/docstring/attributes.html.jinja create mode 100644 mkdocstrings/python/material/docstring/parameters.html.jinja create mode 100644 mkdocstrings/python/material/docstring/raises.html.jinja create mode 100644 mkdocstrings/python/material/docstring/returns.html.jinja diff --git a/mkdocstrings/python/material/docstring/attributes.html.jinja b/mkdocstrings/python/material/docstring/attributes.html.jinja new file mode 100644 index 00000000..ce50d654 --- /dev/null +++ b/mkdocstrings/python/material/docstring/attributes.html.jinja @@ -0,0 +1,90 @@ +{{ log.debug("Rendering attributes section") }} + +{% import "language.html" as lang with context %} + +{% if config.docstring_section_style == "table" %} + {% block table_style scoped %} +

{{ section.title or lang.t("Attributes:") }}

+ + + + + + + + + + {% for attribute in section.value %} + + + + + + {% endfor %} + +
{{ lang.t("Name") }}{{ lang.t("Type") }}{{ lang.t("Description") }}
{{ attribute.name }} + {% if attribute.annotation %} + {% with expression = attribute.annotation %} + {% include "expression.html" with context %} + {% endwith %} + {% endif %} + +
+ {{ attribute.description|convert_markdown(heading_level, html_id) }} +
+
+ {% endblock table_style %} +{% elif config.docstring_section_style == "list" %} + {% block list_style scoped %} +

{{ section.title or lang.t("Attributes:") }}

+ + {% endblock list_style %} +{% elif config.docstring_section_style == "spacy" %} + {% block spacy_style scoped %} + + + + + + + + + {% for attribute in section.value %} + + + + + {% endfor %} + +
{{ (section.title or lang.t("ATTRIBUTE")).rstrip(":").upper() }}{{ lang.t("DESCRIPTION") }}
{{ attribute.name }} +
+ {{ attribute.description|convert_markdown(heading_level, html_id) }} +
+

+ {% if attribute.annotation %} + + TYPE: + {% with expression = attribute.annotation %} + {% include "expression.html" with context %} + {% endwith %} + + {% endif %} +

+
+ {% endblock spacy_style %} +{% endif %} diff --git a/mkdocstrings/python/material/docstring/parameters.html.jinja b/mkdocstrings/python/material/docstring/parameters.html.jinja new file mode 100644 index 00000000..ab4889e8 --- /dev/null +++ b/mkdocstrings/python/material/docstring/parameters.html.jinja @@ -0,0 +1,98 @@ +{{ log.debug("Rendering parameters section") }} + +{% import "language.html" as lang with context %} + +{% if config.docstring_section_style == "table" %} + {% block table_style scoped %} +

{{ section.title or lang.t("Parameters:") }}

+ + + + + + + + + + + {% for parameter in section.value %} + + + + + + + {% endfor %} + +
{{ lang.t("Name") }}{{ lang.t("Type") }}{{ lang.t("Description") }}{{ lang.t("Default") }}
{{ parameter.name }} + {% if parameter.annotation %} + {% with expression = parameter.annotation %} + {% include "expression.html" with context %} + {% endwith %} + {% endif %} + +
+ {{ parameter.description|convert_markdown(heading_level, html_id) }} +
+ 		+ {% if parameter.default %} + {% with expression = parameter.default %} + {% include "expression.html" with context %} + {% endwith %} + {% else %} + {{ lang.t("required") }} + {% endif %} +
+ {% endblock table_style %} +{% elif config.docstring_section_style == "list" %} + {% block list_style scoped %} +

{{ section.title or lang.t("Parameters:") }}

+ + {% endblock list_style %} +{% elif config.docstring_section_style == "spacy" %} + {% block spacy_style scoped %} +

{{ section.title or lang.t("Parameters:") }}

+
+ {% for parameter in section.value %} +
{{ parameter.name }}
+
+
+ {{ parameter.description|convert_markdown(heading_level, html_id) }} +
+ {% if parameter.annotation %}

+ {{ lang.t("TYPE:") }} + {% with expression = parameter.annotation %} + {% include "expression.html" with context %} + {% endwith %} +

{% endif %} + {% if parameter.default %}

+ {{ lang.t("DEFAULT:") }} + {% with expression = parameter.default %} + {% include "expression.html" with context %} + {% endwith %} +

{% endif %} +
+ {% endfor %} +
+ {% endblock spacy_style %} +{% endif %} diff --git a/mkdocstrings/python/material/docstring/raises.html.jinja b/mkdocstrings/python/material/docstring/raises.html.jinja new file mode 100644 index 00000000..628e41b9 --- /dev/null +++ b/mkdocstrings/python/material/docstring/raises.html.jinja @@ -0,0 +1,72 @@ +{{ log.debug("Rendering raises section") }} + +{% import "language.html" as lang with context %} + +{% if config.docstring_section_style == "table" %} + {% block table_style scoped %} +

{{ section.title or lang.t("Raises:") }}

+ + + + + + + + + {% for raises in section.value %} + + + + + {% endfor %} + +
{{ lang.t("Type") }}{{ lang.t("Description") }}
+ {% if raises.annotation %} + {% with expression = raises.annotation %} + {% include "expression.html" with context %} + {% endwith %} + {% endif %} + +
+ {{ raises.description|convert_markdown(heading_level, html_id) }} +
+
+ {% endblock table_style %} +{% elif config.docstring_section_style == "list" %} + {% block list_style scoped %} +

{{ lang.t(section.title) or lang.t("Raises:") }}

+ + {% endblock list_style %} +{% elif config.docstring_section_style == "spacy" %} + {% block spacy_style scoped %} +

{{ (section.title or lang.t("Raises:")) }}

+
+ {% for raises in section.value %} +
+ {% with expression = raises.annotation %} + {% include "expression.html" with context %} + {% endwith %} +
+
+
+ {{ raises.description|convert_markdown(heading_level, html_id) }} +
+
+ {% endfor %} +
+ {% endblock spacy_style %} +{% endif %} diff --git a/mkdocstrings/python/material/docstring/returns.html.jinja b/mkdocstrings/python/material/docstring/returns.html.jinja new file mode 100644 index 00000000..bd608404 --- /dev/null +++ b/mkdocstrings/python/material/docstring/returns.html.jinja @@ -0,0 +1,94 @@ +{{ log.debug("Rendering returns section") }} + +{% import "language.html" as lang with context %} + +{% if config.docstring_section_style == "table" %} + {% block table_style scoped %} + {% set name_column = section.value|selectattr("name")|any %} +

{{ section.title or lang.t("Returns:") }}

+ + + + {% if name_column %}{% endif %} + + + + + + {% for returns in section.value %} + + {% if name_column %}{% endif %} + + + + {% endfor %} + +
{{ lang.t("Name") }}{{ lang.t("Type") }}{{ lang.t("Description") }}
{% if returns.name %}{{ returns.name }}{% endif %} + {% if returns.annotation %} + {% with expression = returns.annotation %} + {% include "expression.html" with context %} + {% endwith %} + {% endif %} + +
+ {{ returns.description|convert_markdown(heading_level, html_id) }} +
+
+ {% endblock table_style %} +{% elif config.docstring_section_style == "list" %} + {% block list_style scoped %} +

{{ section.title or lang.t("Returns:") }}

+ + {% endblock list_style %} +{% elif config.docstring_section_style == "spacy" %} + {% block spacy_style scoped %} +

{{ (section.title or lang.t("Returns:")) }}

+
+ {% for returns in section.value %} +
+ {% if returns.name %} + {{ returns.name }} + {% elif returns.annotation %} + + {% with expression = returns.annotation %} + {% include "expression.html" with context %} + {% endwith %} + + {% endif %} +
+
+
+ {{ returns.description|convert_markdown(heading_level, html_id) }} +
+ {% if returns.name and returns.annotation %} +

+ + {{ lang.t("TYPE:") }} + {% with expression = returns.annotation %} + {% include "expression.html" with context %} + {% endwith %} + +

+ {% endif %} +
+ {% endfor %} +
+ {% endblock spacy_style %} +{% endif %} diff --git a/reference/api/bumpversion/aliases/index.html b/reference/api/bumpversion/aliases/index.html index 667689bd..80a59279 100644 --- a/reference/api/bumpversion/aliases/index.html +++ b/reference/api/bumpversion/aliases/index.html @@ -1927,7 +1927,7 @@ - + @@ -1936,7 +1936,7 @@ - + diff --git a/reference/api/bumpversion/autocast/index.html b/reference/api/bumpversion/autocast/index.html index 38f506e9..825ca93e 100644 --- a/reference/api/bumpversion/autocast/index.html +++ b/reference/api/bumpversion/autocast/index.html @@ -1945,7 +1945,7 @@ - + @@ -1954,7 +1954,7 @@ - + diff --git a/reference/api/bumpversion/bump/index.html b/reference/api/bumpversion/bump/index.html index e04f7030..13f8d1ee 100644 --- a/reference/api/bumpversion/bump/index.html +++ b/reference/api/bumpversion/bump/index.html @@ -1945,7 +1945,7 @@ - + @@ -1954,7 +1954,7 @@ - + diff --git a/reference/api/bumpversion/cli/index.html b/reference/api/bumpversion/cli/index.html index 66969889..fd4348a9 100644 --- a/reference/api/bumpversion/cli/index.html +++ b/reference/api/bumpversion/cli/index.html @@ -1972,7 +1972,7 @@ - + @@ -1981,7 +1981,7 @@ - + diff --git a/reference/api/bumpversion/config/create/index.html b/reference/api/bumpversion/config/create/index.html index d872d368..f431bc40 100644 --- a/reference/api/bumpversion/config/create/index.html +++ b/reference/api/bumpversion/config/create/index.html @@ -1929,7 +1929,7 @@ - + @@ -1938,7 +1938,7 @@ - + diff --git a/reference/api/bumpversion/config/files/index.html b/reference/api/bumpversion/config/files/index.html index f7981e51..725d9980 100644 --- a/reference/api/bumpversion/config/files/index.html +++ b/reference/api/bumpversion/config/files/index.html @@ -1956,7 +1956,7 @@ - + @@ -1965,7 +1965,7 @@ - + diff --git a/reference/api/bumpversion/config/files_legacy/index.html b/reference/api/bumpversion/config/files_legacy/index.html index 2401617d..47b63279 100644 --- a/reference/api/bumpversion/config/files_legacy/index.html +++ b/reference/api/bumpversion/config/files_legacy/index.html @@ -1929,7 +1929,7 @@ - + @@ -1938,7 +1938,7 @@ - + diff --git a/reference/api/bumpversion/config/index.html b/reference/api/bumpversion/config/index.html index 679b36ae..fd3b0c91 100644 --- a/reference/api/bumpversion/config/index.html +++ b/reference/api/bumpversion/config/index.html @@ -1851,7 +1851,7 @@ - + @@ -1860,7 +1860,7 @@ - + diff --git a/reference/api/bumpversion/config/models/index.html b/reference/api/bumpversion/config/models/index.html index fd9862fd..c14d7d41 100644 --- a/reference/api/bumpversion/config/models/index.html +++ b/reference/api/bumpversion/config/models/index.html @@ -1938,7 +1938,7 @@ - + @@ -1947,7 +1947,7 @@ - + diff --git a/reference/api/bumpversion/config/utils/index.html b/reference/api/bumpversion/config/utils/index.html index 6ecf15a3..6c298966 100644 --- a/reference/api/bumpversion/config/utils/index.html +++ b/reference/api/bumpversion/config/utils/index.html @@ -1947,7 +1947,7 @@ - + @@ -1956,7 +1956,7 @@ - + diff --git a/reference/api/bumpversion/context/index.html b/reference/api/bumpversion/context/index.html index f06860aa..aa374388 100644 --- a/reference/api/bumpversion/context/index.html +++ b/reference/api/bumpversion/context/index.html @@ -1963,7 +1963,7 @@ - + @@ -1972,7 +1972,7 @@ - + diff --git a/reference/api/bumpversion/exceptions/index.html b/reference/api/bumpversion/exceptions/index.html index d604971e..6cff481a 100644 --- a/reference/api/bumpversion/exceptions/index.html +++ b/reference/api/bumpversion/exceptions/index.html @@ -1999,7 +1999,7 @@ - + @@ -2008,7 +2008,7 @@ - + diff --git a/reference/api/bumpversion/files/index.html b/reference/api/bumpversion/files/index.html index c6b9b7e9..201e0472 100644 --- a/reference/api/bumpversion/files/index.html +++ b/reference/api/bumpversion/files/index.html @@ -1987,7 +1987,7 @@ - + @@ -1996,7 +1996,7 @@ - + diff --git a/reference/api/bumpversion/hooks/index.html b/reference/api/bumpversion/hooks/index.html index 890cdbec..4ce8e57c 100644 --- a/reference/api/bumpversion/hooks/index.html +++ b/reference/api/bumpversion/hooks/index.html @@ -2026,7 +2026,7 @@ - + @@ -2035,7 +2035,7 @@ - + diff --git a/reference/api/bumpversion/indented_logger/index.html b/reference/api/bumpversion/indented_logger/index.html index 85b8ffe0..3678a8bb 100644 --- a/reference/api/bumpversion/indented_logger/index.html +++ b/reference/api/bumpversion/indented_logger/index.html @@ -1918,7 +1918,7 @@ - + @@ -1927,7 +1927,7 @@ - + diff --git a/reference/api/bumpversion/index.html b/reference/api/bumpversion/index.html index 36dcfc61..57771d12 100644 --- a/reference/api/bumpversion/index.html +++ b/reference/api/bumpversion/index.html @@ -1844,7 +1844,7 @@ - + @@ -1853,7 +1853,7 @@ - + diff --git a/reference/api/bumpversion/scm/index.html b/reference/api/bumpversion/scm/index.html index 78334c0e..ed290374 100644 --- a/reference/api/bumpversion/scm/index.html +++ b/reference/api/bumpversion/scm/index.html @@ -1969,7 +1969,7 @@ - + @@ -1978,7 +1978,7 @@ - + diff --git a/reference/api/bumpversion/show/index.html b/reference/api/bumpversion/show/index.html index 80f674ca..9e18d2ed 100644 --- a/reference/api/bumpversion/show/index.html +++ b/reference/api/bumpversion/show/index.html @@ -1963,7 +1963,7 @@ - + @@ -1972,7 +1972,7 @@ - + diff --git a/reference/api/bumpversion/ui/index.html b/reference/api/bumpversion/ui/index.html index 5039480c..05177c3d 100644 --- a/reference/api/bumpversion/ui/index.html +++ b/reference/api/bumpversion/ui/index.html @@ -1963,7 +1963,7 @@ - + @@ -1972,7 +1972,7 @@ - + diff --git a/reference/api/bumpversion/utils/index.html b/reference/api/bumpversion/utils/index.html index a195d4d6..dbb759d3 100644 --- a/reference/api/bumpversion/utils/index.html +++ b/reference/api/bumpversion/utils/index.html @@ -1999,7 +1999,7 @@ - + @@ -2008,7 +2008,7 @@ - + diff --git a/reference/api/bumpversion/versioning/conventions/index.html b/reference/api/bumpversion/versioning/conventions/index.html index 308266d9..4fa3443c 100644 --- a/reference/api/bumpversion/versioning/conventions/index.html +++ b/reference/api/bumpversion/versioning/conventions/index.html @@ -1938,7 +1938,7 @@ - + @@ -1947,7 +1947,7 @@ - + diff --git a/reference/api/bumpversion/versioning/functions/index.html b/reference/api/bumpversion/versioning/functions/index.html index e23a47d1..5ef376d1 100644 --- a/reference/api/bumpversion/versioning/functions/index.html +++ b/reference/api/bumpversion/versioning/functions/index.html @@ -1965,7 +1965,7 @@ - + @@ -1974,7 +1974,7 @@ - + diff --git a/reference/api/bumpversion/versioning/index.html b/reference/api/bumpversion/versioning/index.html index ab34aac8..030cee18 100644 --- a/reference/api/bumpversion/versioning/index.html +++ b/reference/api/bumpversion/versioning/index.html @@ -1851,7 +1851,7 @@ - + @@ -1860,7 +1860,7 @@ - + diff --git a/reference/api/bumpversion/versioning/models/index.html b/reference/api/bumpversion/versioning/models/index.html index 44b01d98..270a16f8 100644 --- a/reference/api/bumpversion/versioning/models/index.html +++ b/reference/api/bumpversion/versioning/models/index.html @@ -1956,7 +1956,7 @@ - + @@ -1965,7 +1965,7 @@ - + diff --git a/reference/api/bumpversion/versioning/serialization/index.html b/reference/api/bumpversion/versioning/serialization/index.html index 4b2df0e3..a3940bbc 100644 --- a/reference/api/bumpversion/versioning/serialization/index.html +++ b/reference/api/bumpversion/versioning/serialization/index.html @@ -1947,7 +1947,7 @@ - + @@ -1956,7 +1956,7 @@ - + diff --git a/reference/api/bumpversion/versioning/version_config/index.html b/reference/api/bumpversion/versioning/version_config/index.html index b1c26923..7e58e9b0 100644 --- a/reference/api/bumpversion/versioning/version_config/index.html +++ b/reference/api/bumpversion/versioning/version_config/index.html @@ -1929,7 +1929,7 @@ - + @@ -1938,7 +1938,7 @@ - + diff --git a/reference/api/bumpversion/visualize/index.html b/reference/api/bumpversion/visualize/index.html index bf85a58c..eed72771 100644 --- a/reference/api/bumpversion/visualize/index.html +++ b/reference/api/bumpversion/visualize/index.html @@ -1978,7 +1978,7 @@ - + @@ -1987,7 +1987,7 @@ - + diff --git a/reference/api/bumpversion/yaml_dump/index.html b/reference/api/bumpversion/yaml_dump/index.html index 8118b688..b52c1f99 100644 --- a/reference/api/bumpversion/yaml_dump/index.html +++ b/reference/api/bumpversion/yaml_dump/index.html @@ -2023,7 +2023,7 @@ - + @@ -2032,7 +2032,7 @@ - + diff --git a/reference/index.html b/reference/index.html index c62e0199..f2e9df3e 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1886,7 +1886,7 @@

Index

- June 11, 2024 + December 15, 2024 @@ -1897,11 +1897,11 @@

Index

- +