NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

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

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

tacaswell merged 3 commits intomatplotlib:mainfromluke396:add-generate-ref-issue-24673

Jan 9, 2023

Merged

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

tacaswell merged 3 commits intomatplotlib:mainfromluke396:add-generate-ref-issue-24673

Jan 9, 2023

Conversation

Copy link

luke396 commentedJan 6, 2023•
edited
Loading

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 shouldbuild without error).

add ref

553918f

github-actionsbot reviewed

Jan 6, 2023

View reviewed changes

Copy link

github-actionsbot left a comment

Choose a reason for hiding this comment

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

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 uson gitter for real-time discussion.

For details on testing, writing docs, and our review process, please seethe developer guide

We strive to be a welcoming and open project. Please follow ourCode of Conduct.

fix error

826f64f

Copy link

Member

tacaswell commentedJan 6, 2023

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.

tacaswell added the Documentation label

Jan 6, 2023

Copy link

Author

luke396 commentedJan 7, 2023•
edited
Loading

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 amethod 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!

add-for-every-under-examples/

b1b2796

luke396 changed the title~~DOC: add ref for simlple_anim.py~~DOC: add ref for every under examples/

Jan 7, 2023

Copy link

Member

jklymak commentedJan 7, 2023

We should definitely check out pandas make.py.

Copy link

Member

rcomer commentedJan 7, 2023•
edited
Loading

Looks like pandas’ approach is toloop through the docs and exclude everything except the one you ask for. This is in theconf.py and themake.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?