DOC: Add ref for every under examples/animation #24897
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 while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. 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 in no way (that I know of) to render just a single page, you have to build the full docs. If this goes into one of the animation examples it should probably go in to all of them. |
Fine, I saw a method to do like this before. I'm wondering if it's possible to add it. I'm open to trying, even though I'm not very familiar with Sphinx. And, your mean that we should add 'Output generated via matplotlib.animation.Animation.to_jshtml' for every animation example? I agree with that too! |
|
We should definitely check out pandas make.py. |
|
Looks like pandas’ approach is to loop through the docs and exclude everything except the one you ask for. This is in the |
|
Thank you for your work on this @luke396 and congratulations on your first merged Matplotlib PR 🎉 I hope we hear from you again! |
|
@meeseeksdev backport to v3.7.x |
|
Something went wrong ... Please have a look at my logs. |
|
Could not push to auto-backport-of-pr-24897-on-v3.7.x due to error, aborting. |
1 similar comment
|
Could not push to auto-backport-of-pr-24897-on-v3.7.x due to error, aborting. |
PR Summary
Closes #24673
I'm trying to fix issue #24673, but I'm having trouble setting up my local environment to build the HTML for a single page. I looked at the developer documentation (https://matplotlib.org/stable/devel/documenting_mpl.html#building-the-docs), but I couldn't find any guidance on how to do this. It would be helpful if the documentation included instructions on how to build HTML for a single API page or similar.
PR Checklist
Documentation and Tests