FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Add ref for every under examples/animation by luke396 · Pull Request #24897 · matplotlib/matplotlib · GitHub

Repository navigation

DOC: Add ref for every under examples/animation - #24897

Merged
tacaswell merged 3 commits into
matplotlib:mainfrom
luke396:add-generate-ref-issue-24673
Jan 9, 2023
Merged

tacaswell merged 3 commits into
matplotlib:mainfrom
luke396:add-generate-ref-issue-24673

Conversation

luke396 commented Jan 6, 2023 •
edited
Loading

Copy link
Copy Markdown

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

  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Copy link
Copy Markdown
Member

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.

luke396 commented Jan 7, 2023 •
edited
Loading

Copy link
Copy Markdown
Author

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!

luke396 changed the title DOC: add ref for simlple_anim.py DOC: add ref for every under examples/ Jan 7, 2023

jklymak commented Jan 7, 2023

Copy link
Copy Markdown
Member

We should definitely check out pandas make.py.

rcomer commented Jan 7, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Looks like pandas’ approach is to loop through the docs and exclude everything except the one you ask for. This is in the conf.py and the make.py sets the relevant environment variable. So probably could be done with our existing make files - though a python make script might remove the need for separate Windows and Linux make files?

luke396 marked this pull request as ready for review January 8, 2023 02:52
luke396 changed the title DOC: add ref for every under examples/ DOC: Add ref for every under examples/ Jan 9, 2023
tacaswell changed the title DOC: Add ref for every under examples/ DOC: Add ref for every under examples/animation Jan 9, 2023
tacaswell added this to the v3.7.0 milestone Jan 9, 2023
tacaswell merged commit 9a0b72a into matplotlib:main Jan 9, 2023

Copy link
Copy Markdown
Member

Thank you for your work on this @luke396 and congratulations on your first merged Matplotlib PR 🎉 I hope we hear from you again!

Copy link
Copy Markdown
Member

@meeseeksdev backport to v3.7.x

lumberbot-app Bot commented Jan 9, 2023

Copy link
Copy Markdown

Something went wrong ... Please have a look at my logs.

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 9, 2023

lumberbot-app Bot commented Jan 9, 2023

Copy link
Copy Markdown

Could not push to auto-backport-of-pr-24897-on-v3.7.x due to error, aborting.

1 similar comment

lumberbot-app Bot commented Jan 9, 2023

Copy link
Copy Markdown

Could not push to auto-backport-of-pr-24897-on-v3.7.x due to error, aborting.

luke396 deleted the add-generate-ref-issue-24673 branch January 10, 2023 03:00
ksunden mentioned this pull request Feb 20, 2023
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

[Doc]: animation examples show controls; source does not reproduce them

4 participants


Back | FazBrowse Home | New Git URL