+ {% if root_members %}
+ {% set members_list = config.members %}
+ {% else %}
+ {% set members_list = none %}
+ {% endif %}
+
{% if config.group_by_category %}
{% with %}
@@ -13,51 +19,67 @@
{% set extra_level = 0 %}
{% endif %}
- {% if config.show_category_heading and obj.attributes.values()|any %}
- {% filter heading(heading_level, id=html_id ~ "-attributes") %}Attributes{% endfilter %}
- {% endif %}
- {% with heading_level = heading_level + extra_level %}
- {% for attribute in obj.attributes.values()|order_members(config.members_order) %}
- {% if not attribute.is_alias or attribute.is_explicitely_exported %}
- {% include "attribute.html" with context %}
+ {% with attributes = obj.attributes|filter_objects(config.filters, members_list, config.show_if_no_docstring) %}
+ {% if attributes %}
+ {% if config.show_category_heading %}
+ {% filter heading(heading_level, id=html_id ~ "-attributes") %}Attributes{% endfilter %}
{% endif %}
- {% endfor %}
+ {% with heading_level = heading_level + extra_level %}
+ {% for attribute in attributes|order_members(config.members_order, members_list) %}
+ {% if not attribute.is_alias or attribute.is_explicitely_exported %}
+ {% include "attribute.html" with context %}
+ {% endif %}
+ {% endfor %}
+ {% endwith %}
+ {% endif %}
{% endwith %}
- {% if config.show_category_heading and obj.classes.values()|any %}
- {% filter heading(heading_level, id=html_id ~ "-classes") %}Classes{% endfilter %}
- {% endif %}
- {% with heading_level = heading_level + extra_level %}
- {% for class in obj.classes.values()|order_members(config.members_order) %}
- {% if not class.is_alias or class.is_explicitely_exported %}
- {% include "class.html" with context %}
+ {% with classes = obj.classes|filter_objects(config.filters, members_list, config.show_if_no_docstring) %}
+ {% if classes %}
+ {% if config.show_category_heading %}
+ {% filter heading(heading_level, id=html_id ~ "-classes") %}Classes{% endfilter %}
{% endif %}
- {% endfor %}
+ {% with heading_level = heading_level + extra_level %}
+ {% for class in classes|order_members(config.members_order, members_list) %}
+ {% if not class.is_alias or class.is_explicitely_exported %}
+ {% include "class.html" with context %}
+ {% endif %}
+ {% endfor %}
+ {% endwith %}
+ {% endif %}
{% endwith %}
- {% if config.show_category_heading and obj.functions.values()|any %}
- {% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
- {% endif %}
- {% with heading_level = heading_level + extra_level %}
- {% for function in obj.functions.values()|order_members(config.members_order) %}
- {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
- {% if not function.is_alias or function.is_explicitely_exported %}
- {% include "function.html" with context %}
- {% endif %}
+ {% with functions = obj.functions|filter_objects(config.filters, members_list, config.show_if_no_docstring) %}
+ {% if functions %}
+ {% if config.show_category_heading %}
+ {% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
{% endif %}
- {% endfor %}
+ {% with heading_level = heading_level + extra_level %}
+ {% for function in functions|order_members(config.members_order, members_list) %}
+ {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
+ {% if not function.is_alias or function.is_explicitely_exported %}
+ {% include "function.html" with context %}
+ {% endif %}
+ {% endif %}
+ {% endfor %}
+ {% endwith %}
+ {% endif %}
{% endwith %}
{% if config.show_submodules %}
- {% if config.show_category_heading and obj.modules.values()|any %}
- {% filter heading(heading_level, id=html_id ~ "-modules") %}Modules{% endfilter %}
- {% endif %}
- {% with heading_level = heading_level + extra_level %}
- {% for module in obj.modules.values()|order_members(config.members_order) %}
- {% if not module.is_alias or module.is_explicitely_exported %}
- {% include "module.html" with context %}
+ {% with modules = obj.modules|filter_objects(config.filters, members_list, config.show_if_no_docstring) %}
+ {% if modules %}
+ {% if config.show_category_heading %}
+ {% filter heading(heading_level, id=html_id ~ "-modules") %}Modules{% endfilter %}
{% endif %}
- {% endfor %}
+ {% with heading_level = heading_level + extra_level %}
+ {% for module in modules|order_members(config.members_order, members_list) %}
+ {% if not module.is_alias or module.is_explicitely_exported %}
+ {% include "module.html" with context %}
+ {% endif %}
+ {% endfor %}
+ {% endwith %}
+ {% endif %}
{% endwith %}
{% endif %}
@@ -65,7 +87,9 @@
{% else %}
- {% for child in obj.members.values()|order_members(config.members_order) %}
+ {% for child in obj.members|
+ filter_objects(config.filters, members_list, config.show_if_no_docstring)|
+ order_members(config.members_order, members_list) %}
{% if not (obj.kind.value == "class" and child.name == "__init__" and config.merge_init_into_class) %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/class.html b/src/mkdocstrings_handlers/python/templates/material/_base/class.html
index 0e629dbe..ff102c88 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/class.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/class.html
@@ -1,116 +1,113 @@
{{ log.debug("Rendering " + class.path) }}
-{% if config.show_if_no_docstring or class.has_docstrings %}
-
- {% with html_id = class.path %}
-
- {% if not root or config.show_root_heading %}
-
- {% if root %}
- {% set show_full_path = config.show_root_full_path %}
- {% set root_members = True %}
- {% elif root_members %}
- {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
- {% set root_members = False %}
+
+{% with html_id = class.path %}
+
+ {% if root %}
+ {% set show_full_path = config.show_root_full_path %}
+ {% set root_members = True %}
+ {% elif root_members %}
+ {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+ {% set root_members = False %}
+ {% else %}
+ {% set show_full_path = config.show_object_full_path %}
+ {% endif %}
+
+ {% if not root or config.show_root_heading %}
+
+ {% filter heading(heading_level,
+ role="class",
+ id=html_id,
+ class="doc doc-heading",
+ toc_label=class.name) %}
+
+ {% if config.separate_signature %}
+
{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
+ {% elif config.merge_init_into_class and "__init__" in class.members -%}
+ {%- with function = class.members["__init__"] -%}
+ {%- filter highlight(language="python", inline=True) -%}
+ {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
+ {%- include "signature.html" with context -%}
+ {%- endfilter -%}
+ {%- endwith -%}
{% else %}
- {% set show_full_path = config.show_object_full_path %}
+
{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
{% endif %}
- {% filter heading(heading_level,
- role="class",
- id=html_id,
- class="doc doc-heading",
- toc_label=class.name) %}
+ {% with labels = class.labels %}
+ {% include "labels.html" with context %}
+ {% endwith %}
- {% if config.separate_signature %}
-
{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
- {% elif config.merge_init_into_class and "__init__" in class.members -%}
- {%- with function = class.members["__init__"] -%}
- {%- filter highlight(language="python", inline=True) -%}
- {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
- {%- include "signature.html" with context -%}
- {%- endfilter -%}
- {%- endwith -%}
- {% else %}
-
{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
- {% endif %}
+ {% endfilter %}
- {% with labels = class.labels %}
- {% include "labels.html" with context %}
+ {% if config.separate_signature and config.merge_init_into_class %}
+ {% if "__init__" in class.members %}
+ {% with function = class.members["__init__"] %}
+ {% filter highlight(language="python", inline=False) %}
+ {% filter format_signature(config.line_length) %}
+ {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
+ {% include "signature.html" with context %}
+ {% endfilter %}
+ {% endfilter %}
{% endwith %}
+ {% endif %}
+ {% endif %}
+ {% else %}
+ {% if config.show_root_toc_entry %}
+ {% filter heading(heading_level,
+ role="class",
+ id=html_id,
+ toc_label=class.path if config.show_root_full_path else class.name,
+ hidden=True) %}
{% endfilter %}
+ {% endif %}
+ {% set heading_level = heading_level - 1 %}
+ {% endif %}
+
+
+ {% if config.show_bases and class.bases %}
+
+ Bases: {% for expression in class.bases -%}
+ {% include "expression.html" with context %}{% if not loop.last %}, {% endif %}
+ {% endfor -%}
+
+ {% endif %}
- {% if config.separate_signature and config.merge_init_into_class %}
- {% if "__init__" in class.members %}
- {% with function = class.members["__init__"] %}
- {% filter highlight(language="python", inline=False) %}
- {% filter format_signature(config.line_length) %}
- {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
- {% include "signature.html" with context %}
- {% endfilter %}
- {% endfilter %}
- {% endwith %}
- {% endif %}
- {% endif %}
+ {% with docstring_sections = class.docstring.parsed %}
+ {% include "docstring.html" with context %}
+ {% endwith %}
- {% else %}
- {% if config.show_root_toc_entry %}
- {% filter heading(heading_level,
- role="class",
- id=html_id,
- toc_label=class.path,
- hidden=True) %}
- {% endfilter %}
+ {% if config.merge_init_into_class %}
+ {% if "__init__" in class.members and class.members["__init__"].has_docstring %}
+ {% with docstring_sections = class.members["__init__"].docstring.parsed %}
+ {% include "docstring.html" with context %}
+ {% endwith %}
{% endif %}
- {% set heading_level = heading_level - 1 %}
{% endif %}
-
- {% if config.show_bases and class.bases %}
-
- Bases: {% for expression in class.bases -%}
- {% include "expression.html" with context %}{% if not loop.last %}, {% endif %}
- {% endfor -%}
-
- {% endif %}
-
- {% with docstring_sections = class.docstring.parsed %}
- {% include "docstring.html" with context %}
- {% endwith %}
-
+ {% if config.show_source %}
{% if config.merge_init_into_class %}
- {% if "__init__" in class.members and class.members["__init__"].has_docstring %}
- {% with docstring_sections = class.members["__init__"].docstring.parsed %}
- {% include "docstring.html" with context %}
- {% endwith %}
- {% endif %}
- {% endif %}
-
- {% if config.show_source %}
- {% if config.merge_init_into_class %}
- {% if "__init__" in class.members and class.members["__init__"].source %}
-
- Source code in {{ class.relative_filepath }}
- {{ class.members["__init__"].source|highlight(language="python", linestart=class.members["__init__"].lineno, linenums=True) }}
-
- {% endif %}
- {% elif class.source %}
+ {% if "__init__" in class.members and class.members["__init__"].source %}
Source code in {{ class.relative_filepath }}
- {{ class.source|highlight(language="python", linestart=class.lineno, linenums=True) }}
+ {{ class.members["__init__"].source|highlight(language="python", linestart=class.members["__init__"].lineno, linenums=True) }}
{% endif %}
+ {% elif class.source %}
+
+ Source code in {{ class.relative_filepath }}
+ {{ class.source|highlight(language="python", linestart=class.lineno, linenums=True) }}
+
{% endif %}
+ {% endif %}
- {% with obj = class %}
- {% set root = False %}
- {% set heading_level = heading_level + 1 %}
- {% include "children.html" with context %}
- {% endwith %}
-
-
- {% endwith %}
+ {% with obj = class %}
+ {% set root = False %}
+ {% set heading_level = heading_level + 1 %}
+ {% include "children.html" with context %}
+ {% endwith %}
-{% endif %}
+{% endwith %}
+
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html
index b473a8f8..bd1b6963 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html
@@ -1,5 +1,5 @@
-{{ log.debug("Rendering docstring") }}
{% if docstring_sections %}
+ {{ log.debug("Rendering docstring") }}
{% for section in docstring_sections %}
{% if section.kind.value == "text" %}
{{ section.value|convert_markdown(heading_level, html_id) }}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
index 5d0dc85f..9a1409c0 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering attributes section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{{ section.title or "Attributes:" }}
@@ -25,7 +26,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Attributes:" }}
{% for attribute in section.value %}
@@ -40,11 +43,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | ATTRIBUTE |
+ {{ (section.title or "ATTRIBUTE").rstrip(":").upper() }} |
DESCRIPTION |
@@ -69,4 +74,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
index 709a799c..4b9f7339 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering other parameters section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{{ section.title or "Other Parameters:" }}
@@ -25,7 +26,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Other Parameters:" }}
{% for parameter in section.value %}
@@ -40,11 +43,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | PARAMETER |
+ {{ (section.title or "PARAMETER").rstrip(":").upper() }} |
DESCRIPTION |
@@ -69,4 +74,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
index 4a28ae1c..cc954596 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering parameters section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{{ section.title or "Parameters:" }}
@@ -35,7 +36,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Parameters:" }}
{% for parameter in section.value %}
@@ -50,11 +53,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | PARAMETER |
+ {{ (section.title or "PARAMETER").rstrip(":").upper() }} |
DESCRIPTION |
@@ -87,4 +92,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
index 71d76e1f..32ad3506 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering raises section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{{ section.title or "Raises:" }}
@@ -23,7 +24,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Raises:" }}
{% for raises in section.value %}
@@ -38,11 +41,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | RAISES |
+ {{ (section.title or "RAISES").rstrip(":").upper() }} |
DESCRIPTION |
@@ -63,4 +68,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
index 0a6c5b5c..7946329b 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering receives section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{% set name_column = section.value|selectattr("name")|any %}
{{ section.title or "Receives:" }}
@@ -26,7 +27,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Receives:" }}
{% for receives in section.value %}
@@ -43,11 +46,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | RECEIVES |
+ {{ (section.title or "RECEIVES").rstrip(":").upper() }} |
DESCRIPTION |
@@ -82,4 +87,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
index b62c809a..0d620d12 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering returns section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{% set name_column = section.value|selectattr("name")|any %}
{{ section.title or "Returns:" }}
@@ -26,7 +27,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Returns:" }}
{% for returns in section.value %}
@@ -43,11 +46,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | RETURNS |
+ {{ (section.title or "RETURNS").rstrip(":").upper() }} |
DESCRIPTION |
@@ -82,4 +87,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html
index 4b2d6865..e5a59a84 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering warns section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{{ section.title or "Warns:" }}
@@ -23,7 +24,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Warns:" }}
{% for warns in section.value %}
@@ -38,11 +41,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | WARNS |
+ {{ (section.title or "WARNS").rstrip(":").upper() }} |
DESCRIPTION |
@@ -63,4 +68,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html
index b24ce805..22d6828f 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html
@@ -1,5 +1,6 @@
{{ log.debug("Rendering yields section") }}
{% if config.docstring_section_style == "table" %}
+ {% block table_style %}
{% set name_column = section.value|selectattr("name")|any %}
{{ section.title or "Yields:" }}
@@ -26,7 +27,9 @@
{% endfor %}
+ {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
+ {% block list_style %}
{{ section.title or "Yields:" }}
{% for yields in section.value %}
@@ -43,11 +46,13 @@
{% endfor %}
+ {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
+ {% block spacy_style %}
- | YIELDS |
+ {{ (section.title or "YIELDS").rstrip(":").upper() }} |
DESCRIPTION |
@@ -82,4 +87,5 @@
{% endfor %}
+ {% endblock spacy_style %}
{% endif %}
\ No newline at end of file
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/expression.html b/src/mkdocstrings_handlers/python/templates/material/_base/expression.html
index 76a50da7..3347e272 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/expression.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/expression.html
@@ -6,5 +6,7 @@
{%- elif original_expression is string -%}
{{ original_expression }}
{%- else -%}
-
{{ original_expression.source }}
+ {%- with annotation = original_expression|attr(config.annotations_path) -%}
+
{{ annotation }}
+ {%- endwith -%}
{%- endif -%}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/function.html b/src/mkdocstrings_handlers/python/templates/material/_base/function.html
index 13639f57..b9b1696c 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/function.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/function.html
@@ -1,77 +1,74 @@
{{ log.debug("Rendering " + function.path) }}
-{% if config.show_if_no_docstring or function.has_docstrings %}
-
- {% with html_id = function.path %}
+
+{% with html_id = function.path %}
- {% if not root or config.show_root_heading %}
+ {% if root %}
+ {% set show_full_path = config.show_root_full_path %}
+ {% set root_members = True %}
+ {% elif root_members %}
+ {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+ {% set root_members = False %}
+ {% else %}
+ {% set show_full_path = config.show_object_full_path %}
+ {% endif %}
- {% if root %}
- {% set show_full_path = config.show_root_full_path %}
- {% set root_members = True %}
- {% elif root_members %}
- {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
- {% set root_members = False %}
- {% else %}
- {% set show_full_path = config.show_object_full_path %}
- {% endif %}
+ {% if not root or config.show_root_heading %}
- {% filter heading(heading_level,
- role="function",
- id=html_id,
- class="doc doc-heading",
- toc_label=function.name ~ "()") %}
-
- {% if config.separate_signature %}
- {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
- {% else %}
- {% filter highlight(language="python", inline=True) %}
- {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
- {% include "signature.html" with context %}
- {% endfilter %}
- {% endif %}
-
- {% with labels = function.labels %}
- {% include "labels.html" with context %}
- {% endwith %}
-
- {% endfilter %}
+ {% filter heading(heading_level,
+ role="function",
+ id=html_id,
+ class="doc doc-heading",
+ toc_label=function.name ~ "()") %}
{% if config.separate_signature %}
- {% filter highlight(language="python", inline=False) %}
- {% filter format_signature(config.line_length) %}
- {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
- {% include "signature.html" with context %}
- {% endfilter %}
+
{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
+ {% else %}
+ {% filter highlight(language="python", inline=True) %}
+ {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
+ {% include "signature.html" with context %}
{% endfilter %}
{% endif %}
- {% else %}
- {% if config.show_root_toc_entry %}
- {% filter heading(heading_level,
- role="function",
- id=html_id,
- toc_label=function.path,
- hidden=True) %}
+ {% with labels = function.labels %}
+ {% include "labels.html" with context %}
+ {% endwith %}
+
+ {% endfilter %}
+
+ {% if config.separate_signature %}
+ {% filter highlight(language="python", inline=False) %}
+ {% filter format_signature(config.line_length) %}
+ {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
+ {% include "signature.html" with context %}
{% endfilter %}
- {% endif %}
- {% set heading_level = heading_level - 1 %}
+ {% endfilter %}
{% endif %}
-
- {% with docstring_sections = function.docstring.parsed %}
- {% include "docstring.html" with context %}
- {% endwith %}
+ {% else %}
+ {% if config.show_root_toc_entry %}
+ {% filter heading(heading_level,
+ role="function",
+ id=html_id,
+ toc_label=function.path if config.show_root_full_path else function.name,
+ hidden=True) %}
+ {% endfilter %}
+ {% endif %}
+ {% set heading_level = heading_level - 1 %}
+ {% endif %}
- {% if config.show_source and function.source %}
-
- Source code in {{ function.relative_filepath }}
- {{ function.source|highlight(language="python", linestart=function.lineno, linenums=True) }}
-
- {% endif %}
-
+
+ {% with docstring_sections = function.docstring.parsed %}
+ {% include "docstring.html" with context %}
+ {% endwith %}
- {% endwith %}
+ {% if config.show_source and function.source %}
+
+ Source code in {{ function.relative_filepath }}
+ {{ function.source|highlight(language="python", linestart=function.lineno, linenums=True) }}
+
+ {% endif %}
-{% endif %}
+{% endwith %}
+
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/labels.html b/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
index a7e8ec38..4f2f72d9 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
@@ -1,6 +1,6 @@
-{{ log.debug("Rendering labels") }}
{% if labels %}
-
+ {{ log.debug("Rendering labels") }}
+
{% for label in labels %}
{{ label }}
{% endfor %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/module.html b/src/mkdocstrings_handlers/python/templates/material/_base/module.html
index 54e4d4e4..8e14d354 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/module.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/module.html
@@ -1,60 +1,63 @@
{{ log.debug("Rendering " + module.path) }}
-{% if config.show_if_no_docstring or module.has_docstrings %}
-
- {% with html_id = module.path %}
+
+{% with html_id = module.path %}
+
+ {% if root %}
+ {% set show_full_path = config.show_root_full_path %}
+ {% set root_members = True %}
+ {% elif root_members %}
+ {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+ {% set root_members = False %}
+ {% else %}
+ {% set show_full_path = config.show_object_full_path %}
+ {% endif %}
+
+ {% if not root or config.show_root_heading %}
+
+ {% filter heading(heading_level,
+ role="module",
+ id=html_id,
+ class="doc doc-heading",
+ toc_label=module.name) %}
+
+ {% with module_name = module.path if show_full_path else module.name %}
+ {% if config.separate_signature %}
+
{{ module_name }}
+ {% else %}
+
{{ module_name }}
+ {% endif %}
+ {% endwith %}
- {% if not root or config.show_root_heading %}
+ {% with labels = module.labels %}
+ {% include "labels.html" with context %}
+ {% endwith %}
- {% if root %}
- {% set show_full_path = config.show_root_full_path %}
- {% set root_members = True %}
- {% elif root_members %}
- {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
- {% set root_members = False %}
- {% else %}
- {% set show_full_path = config.show_object_full_path %}
- {% endif %}
+ {% endfilter %}
+ {% else %}
+ {% if config.show_root_toc_entry %}
{% filter heading(heading_level,
role="module",
id=html_id,
- class="doc doc-heading",
- toc_label=module.name) %}
-
-
{% if show_full_path %}{{ module.path }}{% else %}{{ module.name }}{% endif %}
-
- {% with labels = module.labels %}
- {% include "labels.html" with context %}
- {% endwith %}
-
+ toc_label=module.path if config.show_root_full_path else module.name,
+ hidden=True) %}
{% endfilter %}
-
- {% else %}
- {% if config.show_root_toc_entry %}
- {% filter heading(heading_level,
- role="module",
- id=html_id,
- toc_label=module.path,
- hidden=True) %}
- {% endfilter %}
- {% endif %}
- {% set heading_level = heading_level - 1 %}
{% endif %}
-
-
- {% with docstring_sections = module.docstring.parsed %}
- {% include "docstring.html" with context %}
- {% endwith %}
-
- {% with obj = module %}
- {% set root = False %}
- {% set heading_level = heading_level + 1 %}
- {% include "children.html" with context %}
- {% endwith %}
-
-
- {% endwith %}
+ {% set heading_level = heading_level - 1 %}
+ {% endif %}
+
+
+ {% with docstring_sections = module.docstring.parsed %}
+ {% include "docstring.html" with context %}
+ {% endwith %}
+
+ {% with obj = module %}
+ {% set root = False %}
+ {% set heading_level = heading_level + 1 %}
+ {% include "children.html" with context %}
+ {% endwith %}
-{% endif %}
+{% endwith %}
+
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/signature.html b/src/mkdocstrings_handlers/python/templates/material/_base/signature.html
index fb116880..ca4bbd44 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/signature.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/signature.html
@@ -1,5 +1,5 @@
-{{ log.debug("Rendering signature of " + function.path) }}
{%- if config.show_signature -%}
+ {{ log.debug("Rendering signature") }}
{%- with -%}
{%- set ns = namespace(render_pos_only_separator=True, render_kw_only_separator=True, equal="=") -%}
diff --git a/tests/conftest.py b/tests/conftest.py
index ab919d29..6e7766b1 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -86,16 +86,16 @@ def fixture_ext_markdown(plugin):
return plugin.md
-@pytest.fixture(name="renderer")
-def fixture_renderer(plugin):
- """Return a PythonRenderer instance.
+@pytest.fixture(name="handler")
+def fixture_handler(plugin):
+ """Return a handler instance.
Parameters:
plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
Returns:
- A renderer instance.
+ A handler instance.
"""
handler = plugin.handlers.get_handler("python")
- handler.renderer._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
- return handler.renderer
+ handler._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
+ return handler
diff --git a/tests/test_collector.py b/tests/test_collector.py
deleted file mode 100644
index 53544c77..00000000
--- a/tests/test_collector.py
+++ /dev/null
@@ -1,31 +0,0 @@
-"""Tests for the `collector` module."""
-
-import pytest
-
-from mkdocstrings_handlers.python.collector import CollectionError, PythonCollector
-
-
-def test_collect_missing_module():
- """Assert error is raised for missing modules."""
- collector = PythonCollector()
- with pytest.raises(CollectionError):
- collector.collect("aaaaaaaa", {})
-
-
-def test_collect_missing_module_item():
- """Assert error is raised for missing items within existing modules."""
- collector = PythonCollector()
- with pytest.raises(CollectionError):
- collector.collect("mkdocstrings.aaaaaaaa", {})
-
-
-def test_collect_module():
- """Assert existing module can be collected."""
- collector = PythonCollector()
- assert collector.collect("mkdocstrings", {})
-
-
-def test_collect_with_null_parser():
- """Assert we can pass `None` as parser when collecting."""
- collector = PythonCollector()
- assert collector.collect("mkdocstrings", {"docstring_style": None})
diff --git a/tests/test_handler.py b/tests/test_handler.py
new file mode 100644
index 00000000..5a49a8b1
--- /dev/null
+++ b/tests/test_handler.py
@@ -0,0 +1,60 @@
+"""Tests for the `handler` module."""
+
+import pytest
+from griffe.docstrings.dataclasses import DocstringSectionExamples, DocstringSectionKind
+
+from mkdocstrings_handlers.python.handler import CollectionError, get_handler
+
+
+def test_collect_missing_module():
+ """Assert error is raised for missing modules."""
+ handler = get_handler(theme="material")
+ with pytest.raises(CollectionError):
+ handler.collect("aaaaaaaa", {})
+
+
+def test_collect_missing_module_item():
+ """Assert error is raised for missing items within existing modules."""
+ handler = get_handler(theme="material")
+ with pytest.raises(CollectionError):
+ handler.collect("mkdocstrings.aaaaaaaa", {})
+
+
+def test_collect_module():
+ """Assert existing module can be collected."""
+ handler = get_handler(theme="material")
+ assert handler.collect("mkdocstrings", {})
+
+
+def test_collect_with_null_parser():
+ """Assert we can pass `None` as parser when collecting."""
+ handler = get_handler(theme="material")
+ assert handler.collect("mkdocstrings", {"docstring_style": None})
+
+
+@pytest.mark.parametrize(
+ "handler",
+ [
+ {"theme": "mkdocs"},
+ {"theme": "readthedocs"},
+ {"theme": {"name": "material"}},
+ ],
+ indirect=["handler"],
+)
+def test_render_docstring_examples_section(handler):
+ """Assert docstrings' examples section can be rendered.
+
+ Parameters:
+ handler: A handler instance (parametrized).
+ """
+ section = DocstringSectionExamples(
+ value=[
+ (DocstringSectionKind.text, "This is an example."),
+ (DocstringSectionKind.examples, ">>> print('Hello')\nHello"),
+ ],
+ )
+ template = handler.env.get_template("docstring/examples.html")
+ rendered = template.render(section=section)
+ assert "
This is an example.
" in rendered
+ assert "print" in rendered
+ assert "Hello" in rendered
diff --git a/tests/test_renderer.py b/tests/test_renderer.py
deleted file mode 100644
index 31232e12..00000000
--- a/tests/test_renderer.py
+++ /dev/null
@@ -1,45 +0,0 @@
-"""Tests for the `renderer` module."""
-
-import pytest
-from griffe.docstrings.dataclasses import DocstringSection, DocstringSectionKind
-
-
-@pytest.mark.parametrize(
- "renderer",
- [
- {"theme": "mkdocs"},
- {"theme": "readthedocs"},
- {"theme": {"name": "material"}},
- ],
- indirect=["renderer"],
-)
-def test_render_docstring_examples_section(renderer):
- """Assert docstrings' examples section can be rendered.
-
- Parameters:
- renderer: A renderer instance (parametrized).
- """
- section = DocstringSection(
- DocstringSectionKind.examples,
- value=[
- (DocstringSectionKind.text, "This is an example."),
- (DocstringSectionKind.examples, ">>> print('Hello')\nHello"),
- ],
- )
- template = renderer.env.get_template("docstring/examples.html")
- rendered = template.render(section=section)
- assert "
This is an example.
" in rendered
- assert "print" in rendered
- assert "Hello" in rendered
-
-
-def test_format_code_and_signature(renderer):
- """Assert code and signatures can be Black-formatted.
-
- Parameters:
- renderer: A renderer instance (parametrized).
- """
- assert renderer.do_format_code("print('Hello')", 100)
- assert renderer.do_format_code('print("Hello")', 100)
- assert renderer.do_format_signature("(param: str = 'hello') -> 'Class'", 100)
- assert renderer.do_format_signature('(param: str = "hello") -> "Class"', 100)
diff --git a/tests/test_rendering.py b/tests/test_rendering.py
new file mode 100644
index 00000000..533eaf34
--- /dev/null
+++ b/tests/test_rendering.py
@@ -0,0 +1,42 @@
+"""Tests for the `rendering` module."""
+
+import re
+from dataclasses import dataclass
+
+import pytest
+
+from mkdocstrings_handlers.python import rendering
+
+
+def test_format_code_and_signature():
+ """Assert code and signatures can be Black-formatted."""
+ assert rendering.do_format_code("print('Hello')", 100)
+ assert rendering.do_format_code('print("Hello")', 100)
+ assert rendering.do_format_signature("(param: str = 'hello') -> 'Class'", 100)
+ assert rendering.do_format_signature('(param: str = "hello") -> "Class"', 100)
+
+
+@dataclass
+class _FakeObject:
+ name: str
+
+
+@pytest.mark.parametrize(
+ ("names", "filter_params", "expected_names"),
+ [
+ (["aa", "ab", "ac", "da"], {"filters": [(re.compile("^a[^b]"), True)]}, {"ab", "da"}),
+ (["aa", "ab", "ac", "da"], {"members_list": ["aa", "ab"]}, {"aa", "ab"}),
+ ],
+)
+def test_filter_objects(names, filter_params, expected_names):
+ """Assert the objects filter works correctly.
+
+ Parameters:
+ names: Names of the objects.
+ filter_params: Parameters passed to the filter function.
+ expected_names: Names expected to be kept.
+ """
+ objects = {name: _FakeObject(name) for name in names}
+ filtered = rendering.do_filter_objects(objects, **filter_params)
+ filtered_names = {obj.name for obj in filtered}
+ assert set(filtered_names) == set(expected_names)
diff --git a/tests/test_themes.py b/tests/test_themes.py
index 44426fb6..b1e7d5d5 100644
--- a/tests/test_themes.py
+++ b/tests/test_themes.py
@@ -35,6 +35,6 @@ def test_render_themes_templates_python(module, plugin):
plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
"""
handler = plugin.handlers.get_handler("python")
- handler.renderer._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
- data = handler.collector.collect(module, {})
- handler.renderer.render(data, {})
+ handler._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
+ data = handler.collect(module, {})
+ handler.render(data, {})
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+