Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Added link and image to matplotlib.hatch API Page #27203

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

Closed
wants to merge 1 commit into from
Closed

Added link and image to matplotlib.hatch API Page #27203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added doc/_static/hatch_preview_first.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions doc/api/hatch_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@
:members:
:undoc-members:
:show-inheritance:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preamble being added in this PR should go above the sphinx directives b/c those directives populate the page w/ the function signature.

.. _Click to see example gallery references: https://matplotlib.org/devdocs/gallery/shapes_and_collections/hatch_style_reference.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use cross-referencing because that forwards to the matching page for that version of the docs
https://sphinx-gallery.github.io/stable/advanced.html#cross-referencing


.. plot:: doc_static/hatch_preview_first.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you do not need to (and we prefer you don't) create the file. Sphinx gallery creates all the images when we build the docs & provides an image you can use here.

https://sphinx-gallery.github.io/stable/advanced.html#cross-referencing

One way to find the path you're looking for is to build the docs and look at the name of the resulting image.