Add test for autosummary with autodoc-pydantic

tests/roots/test-ext-autosummary-pydantic/_templates/autosummary/module.rst

@@ -0,0 +1,84 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attribute %}
+   {% if attribute %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+   {% for item in attribute %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block function %}
+   {% if function %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+   {% for item in function %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block class %}
+   {% if class %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+   {% for item in class %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block pydantic_model %}
+   {% if pydantic_model %}
+   .. rubric:: {{ _('Models') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in pydantic_model %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block pydantic_settings %}
+   {% if pydantic_settings %}
+   .. rubric:: {{ _('Settings') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in pydantic_settings %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exception %}
+   {% if exception %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+   {% for item in exception %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: {{ _('Modules') }}
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

tests/roots/test-ext-autosummary-pydantic/autosummary_dummy_module_with_pydantic.py

@@ -0,0 +1,9 @@
+__all__ = [
+    "MyModel",
+]
+
+from pydantic import BaseModel
+
+
+class MyModel(BaseModel):
+    attr: str

tests/roots/test-ext-autosummary-pydantic/conf.py

@@ -0,0 +1,12 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('.'))
+
+extensions = ['sphinx.ext.autosummary', "sphinxcontrib.autodoc_pydantic"]
+autosummary_generate = True
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+templates_path = ["_templates"]

tests/roots/test-ext-autosummary-pydantic/index.rst

@@ -0,0 +1,8 @@
+test-ext-autosummary-pydantic
+=============================
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   autosummary_dummy_module_with_pydantic

tests/test_extensions/test_ext_autosummary.py

@@ -1,5 +1,6 @@
 """Test the autosummary extension."""
 
+import importlib.util
 import sys
 from io import StringIO
 from pathlib import Path
@@ -268,6 +269,22 @@ def test_autosummary_generate_content_for_module_by_objtype(app):
     assert context['module'] == 'autosummary_dummy_module'
 
 
+@pytest.mark.skipif(not importlib.util.find_spec("sphinxcontrib.autodoc_pydantic"), reason="Requires pydantic, autodoc-pydantic")
+@pytest.mark.sphinx(testroot='ext-autosummary-pydantic')
+def test_autosummary_generate_content_for_module_with_pydantic(app):
+    import autosummary_dummy_module_with_pydantic
+    template = Mock()
+
+    generate_autosummary_content('autosummary_dummy_module_with_pydantic', autosummary_dummy_module_with_pydantic, None,
+                                 template, None, False, app, False, {})
+    assert template.render.call_args[0][0] == 'module'
+
+    context = template.render.call_args[0][1]
+
+    assert context['pydantic_model'] == ['MyModel']
+    assert 'MyModel' not in context['class']
+
+
 @pytest.mark.sphinx(testroot='ext-autosummary')
 def test_autosummary_generate_content_for_module___all__(app):
     import autosummary_dummy_module