Skip to content

DOC: rename doc/gallery directory doc/examples? #9877

Open

Description

@jklymak

It is confusing for the output of examples to be put into the directory docs/gallery. Opening as an issue because I'm a) not sure how big a change it is (i.e. how many links break) and b) maybe there is a good reason for the name.

#9872 (comment)

Activity

  1. tacaswell commented on Nov 29, 2017

    @tacaswell
    Member

    for a) It will re-break a bunch of links we just broke with 2.1 for b) gallery seems a bit clearer for what it is

  2. added this to the milestone on Nov 29, 2017
  3. anntzer commented on Nov 29, 2017

    @anntzer
    Contributor

    Renaming the examples folder to gallery in the source tree would be fine too...

  4. jklymak commented on Dec 3, 2017

    @jklymak
    MemberAuthor

    I guess the difference is that a bunch of other stuff ends up in gallery as well. i.e. all the png files for the tutorials or any plots made in the docs. Still, it is confusing.

  5. github-actions commented on Apr 25, 2023

    @github-actions

    This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!

  6. jklymak commented on Apr 25, 2023

    @jklymak
    MemberAuthor

    I think we should still do this. Currently seems as easy as a server-side redirect.

    1. Do redirect
    2. Change all top-level navigation links
    3. grep for all internal links. I think most of the internal links should already be to examples, the way sphinx works, so I actually think this (and maybe 2) are not any work at all

    @QuLogic would be the correct person to ask bout the server-side redirect.

  7. added
    keepItems to be ignored by the “Stale” Github Action
    and removed
    status: inactiveMarked by the “Stale” Github Action
    on Apr 25, 2023
  8. melissawm commented on Apr 25, 2023

    @melissawm
    Member

    We could also do this as a consequence/as part of our Google Season of Docs project

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationkeepItems to be ignored by the “Stale” Github Action

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions