Show which examples use an object in the API documentation

.gitignore

@@ -30,7 +30,7 @@ dist/
 
 # autogenerated docs
 _autosummary
-
+_gallery_backreferences
 
 # Testing
 .coverage

doc/make.bat

@@ -34,7 +34,7 @@ goto end
 
 :clean
 rmdir /s /q %BUILDDIR% > /NUL 2>&1
-for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
+for /d /r %SOURCEDIR% %%d in (_autosummary,_gallery_backreferences) do @if exist "%%d" rmdir /s /q "%%d"
 rmdir /s /q %SOURCEDIR%\examples\gallery_examples
 goto end
 

doc/source/_templates/autosummary/base.rst

@@ -0,0 +1,12 @@
+.. vale off
+
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
+
+.. minigallery::
+   :add-heading: Examples using {{ objname }}
+
+   {{ module }}.{{ objname }}

doc/source/_templates/autosummary/class.rst

@@ -0,0 +1,39 @@
+.. vale off
+
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in methods %}
+      {% if item != "__init__" %}
+      {{ name }}.{{ item }}
+      {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+.. minigallery::
+   :add-heading: Examples using {{ objname }}
+
+   {{ module }}.{{ objname }}

doc/source/_templates/autosummary/experimental/base.rst.jinja2

@@ -0,0 +1,14 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. warning::
+
+    This is an experimental feature. The API is subject to change without notice.
+
+.. auto{{ objtype }}:: {{ objname }}
+
+.. minigallery::
+   :add-heading: Examples using {{ objname }}
+
+   {{ module }}.{{ objname }}

doc/source/_templates/autosummary/no_methods_doc/class.rst.jinja2

@@ -17,3 +17,9 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+
+.. minigallery::
+   :add-heading: Examples using {{ objname }}
+
+   {{ module }}.{{ objname }}

doc/source/conf.py

@@ -275,9 +275,10 @@ def _signature(
     # Sort gallery example by filename instead of number of lines (default)
     "within_subsection_order": "FileNameSortKey",
     # directory where function granular galleries are stored
-    "backreferences_dir": None,
-    # Modules for which function level galleries are created.  In
-    "doc_module": "ansys-acp-core",
+    "backreferences_dir": "api/_gallery_backreferences",
+    # Modules for which function level galleries are created.
+    "doc_module": ("ansys.acp.core"),
+    "exclude_implicit_doc": {"ansys\\.acp\\.core\\._.*"},  # ignore private submodules
     "image_scrapers": (DynamicScraper(), "matplotlib"),
     "ignore_pattern": r"__init__\.py",
     "thumbnail_size": (350, 350),