Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc][Examples Gallery]: Side Navigation Section breaks on Animation examples #25836

Closed
@codingtosh

Description

@codingtosh

Documentation Link

https://matplotlib.org/devdocs/gallery/animation/index.html

Problem

Steps:

  1. Go to Animations from the navigation section on the left hand side.
  2. 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
expected behavior

Actual Outcome: Side navigation section shows the matplotlib API reference links instead.

unexpected behavior

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:

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:
unexpected div
should be more like the expected div:
expected div

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationGood first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions