Repository navigation
[Doc]: List supported hatches and link to/embed hatch reference on hatches API page #27196
Description
Documentation Link
Problem
The hatches API landing page is very sparse and I think some folks landing on this page are probably trying to find the list of supported hatches.
Suggested improvement
Minimally, I think the API reference should link/refer to the example gallery reference, but I also think maybe the first image from the gallery reference should be embedded at the top of the API reference page (via the .. plot:: path/to/image directive)
This is the file that would be changed in addressing this issue:
matplotlib/doc/api/hatch_api.rst
Lines 1 to 8 in 879cf76
Activity
github-actions commentedon Oct 25, 2023
Good first issue - notes for new contributors
This issue is suited to new contributors because it does not require understanding of the Matplotlib internals. To get started, please see our contributing guide.
We do not assign issues. Check the Development section in the sidebar for linked pull requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please collaborate on the work by reviewing it rather than duplicating it in a competing PR.
If something is unclear, please reach out on any of our communication channels.
Ashhar-24 commentedon Oct 26, 2023
Hey @story645 , I would love to work on this!
But I'm not able to understand how should I edit "matplotlib/doc/api/hatch_api.rst" file so that that API reference page will also show images of the hatches.
Kindly guide me through.
Thanks
btwshivam commentedon Oct 26, 2023
I want to work on it assign me!
story645 commentedon Oct 26, 2023
Sorry @shivam200446 we do not assign issues & there's already an opened pull request about this.
ikigai27 commentedon Nov 4, 2023
(plot:: path/to/image) appears to be used in documentation tools like Sphinx @story645
story645 commentedon Nov 4, 2023
@ikigai27 yes, our docs are built with sphinx. I'm not sure if you're asking a question or answering someone elses.
ikigai27 commentedon Nov 7, 2023
@story645 Permission to matplotlib denied to ikigai27. how to solve any guidance.
story645 commentedon Nov 7, 2023
What are you doing to get that error?
ikigai27 commentedon Nov 8, 2023
making PR it gives an error while pushing the changes to origin repository
story645 commentedon Nov 8, 2023
Did you follow our guide for making the changes on a feature branch on your own fork?
https://matplotlib.org/devdocs/devel/contribute.html#how-to-contribute
If not, I suggest you follow our instructions and then copy your changes over.
QuLogic commentedon Jul 13, 2024
Also should add an
mpl-typerole entry for this new page.