Skip to content

Commit

Permalink
Add mini-galleries for methods and functions (#648)
Browse files Browse the repository at this point in the history
This PR updates the autosummary templates, to show mini-galleries of 
all methods and functions at the end of the documentation page.
  • Loading branch information
seisman authored Oct 11, 2020
1 parent 96a32b9 commit 3613b19
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/_templates/autosummary/function.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

.. autofunction:: {{ objname }}

.. include:: backreferences/{{ fullname }}.examples

.. raw:: html

Expand Down
11 changes: 11 additions & 0 deletions doc/_templates/autosummary/method.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{ fullname | escape | underline }}

.. currentmodule:: {{ module }}

.. automethod:: {{ objname }}

.. include:: backreferences/{{ fullname }}.examples

.. raw:: html

<div style='clear:both'></div>

0 comments on commit 3613b19

Please sign in to comment.