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

Skip to content

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

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jklymak opened this issue Nov 28, 2017 · 6 comments
Open

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

jklymak opened this issue Nov 28, 2017 · 6 comments
Labels
Documentation keep Items to be ignored by the “Stale” Github Action

Comments

@jklymak
Copy link
Member

jklymak commented Nov 28, 2017

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)

@tacaswell
Copy link
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

@tacaswell tacaswell added this to the v2.2 milestone Nov 29, 2017
@anntzer
Copy link
Contributor

anntzer commented Nov 29, 2017

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

@jklymak
Copy link
Member Author

jklymak commented Dec 3, 2017

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.

@github-actions
Copy link

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!

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Apr 25, 2023
@jklymak
Copy link
Member Author

jklymak commented Apr 25, 2023

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.

@jklymak jklymak added keep Items to be ignored by the “Stale” Github Action and removed status: inactive Marked by the “Stale” Github Action labels Apr 25, 2023
@melissawm
Copy link
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
Labels
Documentation keep Items to be ignored by the “Stale” Github Action
Projects
None yet
Development

No branches or pull requests

4 participants