Repository navigation
[Doc][Examples Gallery]: Side Navigation Section breaks on Animation examples #25836
Description
Documentation Link
https://matplotlib.org/devdocs/gallery/animation/index.html
Problem
Steps:
- Go to Animations from the navigation section on the left hand side.
- Click on the animation examples either from the side navigation section or from the thumbnails in the main page.
Expected Outcome: Side navigation section continues to show the links of examples gallery
Actual Outcome: Side navigation section shows the matplotlib API reference links instead.
Result: UX is negatively affected, navigation is inconsistent compared to everywhere else in the documentation.
Note: Not reproducible for these examples, breaks for all other animation examples:
- pyplot animation
- Multiple axes animation
- pasuing and resuming an animation
- animated scatter saved as gif
Possible reasons: Animation renderer could have something to do with it, but then again, the above 4 examples don't reflect that. Needs root cause analysis.
Reproducible in Mozilla Firefox, Edge as well as Chrome. Reproducible across devdocs, stable and the older versions.
Actionability: The scope is limited to the Animation examples in the Examples Gallery as far as I have found out. For now, this issue isn't critical or high priority.
Suggested improvement
The section navigation div should contain the toctree of the Examples gallery links, not the API reference links.
Fix should have this result:
Unexpected div:
should be more like the expected div:
Activity
codingtosh commentedon May 8, 2023
@story645 @melissawm This was the issue we discussed. Web dev isn't my forte, but should be labelled good-first-issue imo.
ksunden commentedon May 8, 2023
I have the (unproven) suspicion that all that is required is changing one of the following two headings (plus perhaps checking links to them):
matplotlib/galleries/examples/animation/README.txt
Lines 5 to 6 in 1539614
matplotlib/doc/api/animation_api.rst
Lines 15 to 16 in 1539614
Marking as good first issue.
sajal1123 commentedon May 10, 2023
Hi @codingtosh, I was exploring the code and noticed that the autosummary directive in
animation_api.rstdoes not follow the template provided inautosummary.rst- whereas some of the other files underdoc/apifollow it. Could this be the source of this issue?I am new to this repository(and open source), so apologies if I'm missing something trivial. Can you also let me know how I can test a change for this issue?
codingtosh commentedon May 13, 2023
Hi @sajal1123 Thanks for looking into this, welcome to the community and open source in general. Have fun!
As a starting point, you should go over this and then this to help you set up the environment and test the changes locally.
You can also join the matplotlib gitter server and get in the the incubator channel where members can help you through with your first PR.
I'm new to this community and the project as well, you can wait for maintainers to comment on your PR or tag @melissawm @story645 @ksunden @tacaswell as they're seasoned contributors in this community and will be able to review and merge your changes in production.
Generally, you should ask the maintainers to assign you a specific issue before you open the PR as this prevents multiple contributors from working on the same issue. But according to the contributing guide above, there is no such practice here in matplotlib. So you can claim an issue simply by commenting on this issue thread and then opening the PR. It will be good to reference this issue number in the PR you open to provide context to the reviewers. Make sure the issue number is prefixed by a pound sign(#) which will create the hyperlink on github.
Another useful practice is to use
git blamein your cli to see who has authored the lines you intend to change and the commit they did it in(helps you understand the context of the change). Then you can tag them in your PR as well. Alterantively, you can use the github platform to see the authorship info like here.While I may not be able to help you directly with the changes, let me know if you face any blockers pertaining to git or open source in general.
[-][Doc][Examples Gallery]: Side Navigation Section breaks on Animation examples. [/-][+][Doc][Examples Gallery]: Side Navigation Section breaks on Animation examples[/+]QuLogic commentedon May 25, 2023
Fixed by #25977.