Added link and image to matplotlib.hatch API Page #27203
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
There was a problem hiding this comment.
Thank you for tackling this!
Please see our contributing guide for information on how to set up a development environment and how to build the docs as I think that may make it easier to implement the
solution proposed in the issue.
https://matplotlib.org/devdocs/devel/index.html#new-contributors
|
|
||
| .. _Click to see example gallery references: https://matplotlib.org/devdocs/gallery/shapes_and_collections/hatch_style_reference.html | ||
|
|
||
| .. plot:: doc_static/hatch_preview_first.png |
There was a problem hiding this comment.
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.
| @@ -6,3 +6,7 @@ | |||
| :members: | |||
| :undoc-members: | |||
| :show-inheritance: | |||
|
|
|||
| .. _Click to see example gallery references: https://matplotlib.org/devdocs/gallery/shapes_and_collections/hatch_style_reference.html | |||
There was a problem hiding this comment.
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
| @@ -6,3 +6,7 @@ | |||
| :members: | |||
| :undoc-members: | |||
| :show-inheritance: | |||
|
|
|||
There was a problem hiding this comment.
The preamble being added in this PR should go above the sphinx directives b/c those directives populate the page w/ the function signature.
|
Hey @Ashhar-24 do you plan to get back to this? |
|
@story645 Hello, I am new and looking to make my first pr. I am reading into this issue and I may be of some help. Right now I am gathering all necessary information on how to properly complete and test this issue. In the mean time I will keep an eye out for further developments! |
|
Ok, but also this is a pull request not an issue so @Ashhar-24 has done a lot of the work and what's left is to address the review comments. If @Ashhar-24 doesn't have the bandwidth to finish up, you're welcome to take over. |
|
@story645 My apologies, thank you for the clarification. Would it be appropriate to create a separate pr? |
|
I think if it's stalled out, then you can take over by making a new PR but credit @Ashhar-24 as a co-author. Maybe wait a another day to see if they respond? |
|
closing in favor of #27370 |
|
@story645 did you forget to close? |
PR summary
PR checklist