Skip to content

Use the minigallery directive to insert mini gallery in API documentation #2459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seisman merged 2 commits into from
Mar 28, 2023
Merged

Use the minigallery directive to insert mini gallery in API documentation #2459

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6cd8ae
Use the minigallery directive to insert mini gallery in API documenta…
seisman Mar 26, 2023
de24966
Merge branch 'main' into improve-minigallery
yvonnefroehlich Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
{% endfor %}
{% endif %}

.. include:: backreferences/{{ fullname }}.examples
.. minigallery:: {{ fullname }}
:add-heading:

.. raw:: html

Expand Down
3 changes: 2 additions & 1 deletion doc/_templates/autosummary/function.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

.. autofunction:: {{ objname }}

.. include:: backreferences/{{ fullname }}.examples
.. minigallery:: {{ fullname }}
:add-heading:

.. raw:: html

Expand Down
3 changes: 2 additions & 1 deletion doc/_templates/autosummary/method.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

.. automethod:: {{ objname }}

.. include:: backreferences/{{ fullname }}.examples
.. minigallery:: {{ fullname }}
:add-heading:

.. raw:: html

Expand Down