[DOC] Add minigalleries to API reference pages (#991)

* add minigalleries to API reference pages

* update templates

* whatsnew

Author: kandersolar

docs/sphinx/source/_templates/autosummary/class.rst

@@ -0,0 +1,35 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{# not sure how to get the minigallery directive to not render empty #}
+{# galleries, so just use the old `include` style instead #}
+{# .. minigallery:: {{ fullname }} #}
+
+.. include:: gallery_backreferences/{{fullname}}.examples

docs/sphinx/source/_templates/autosummary/function.rst

@@ -0,0 +1,11 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ fullname }}
+
+{# not sure how to get the minigallery directive to not render empty #}
+{# galleries, so just use the old `include` style instead #}
+{# .. minigallery:: {{ fullname }} #}
+
+.. include:: gallery_backreferences/{{fullname}}.examples

docs/sphinx/source/_templates/autosummary/method.rst

@@ -0,0 +1,11 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. automethod:: {{ fullname }}
+
+{# not sure how to get the minigallery directive to not render empty #}
+{# galleries, so just use the old `include` style instead #}
+{# .. minigallery:: {{ fullname }} #}
+
+.. include:: gallery_backreferences/{{fullname}}.examples

docs/sphinx/source/conf.py

@@ -341,6 +341,13 @@ def setup(app):
     'gallery_dirs': ['auto_examples'],  # location of generated output
     # sphinx-gallery only shows plots from plot_*.py files by default:
     # 'filename_pattern': '*.py',
+
+    # directory where function/class granular galleries are stored
+    'backreferences_dir': 'generated/gallery_backreferences',
+
+    # Modules for which function/class level galleries are created. In
+    # this case only pvlib, could include others though.  must be tuple of str
+    'doc_module': ('pvlib',),
 }
 # supress warnings in gallery output
 # https://sphinx-gallery.github.io/stable/configuration.html

docs/sphinx/source/whatsnew/v0.8.0.rst

@@ -54,6 +54,7 @@ Documentation
 * Add a transposition gain example to the gallery.  (:pull:`979`)
 * Add a gallery example of calculating diffuse IAM using
   :py:func:`pvlib.iam.marion_diffuse`. (:pull:`984`)
+* Add minigalleries to API reference pages. (:pull:`991`)
 
 Requirements
 ~~~~~~~~~~~~