This reorganizes all the galleries (examples, tutorials, plot_types) under one subdirectory. Also renames examples->gallery so that it is the same name as the gallery it makes.

So now sphinx-gallery looks in/galleries/gallery,/galleries/tutorials/ and/galleries/plot_types.

The goal here is that now thatsphinx-gallery/sphinx-gallery#1071 is in, we may have more subdirectories run through sphinx gallery (perhaps many more), and it pollutes the top-level file hierarchy to have a bunch of these.

Note that no examples were changed by this, and there should be no difference on the doc page (except in the "writing Documentation" page where the file names have changed).

PR Checklist

Documentation and Tests

Has pytest style unit tests (andpytest passes)
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
New plotting related features are documented with examples.

Release Notes

New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

jklymak added the Documentation: overhaul label

Feb 14, 2023

jklymak commented

Feb 14, 2023

View reviewed changes

doc/devel/documenting_mpl.rst

		files in:file:`plot_types/`,:file:`examples/` and:file:`tutorials/`.
		These sources consist of python scripts that haveReST_ documentation built
		into their comments. See:ref:`writing-examples-and-tutorials` below.
		:file:`doc/tutorials` are generated by the `Sphinx Gallery`_ from python files

Copy link

MemberAuthor

jklymakFeb 14, 2023

Choose a reason for hiding this comment

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

This file is the only user-facing change.

jklymak force-pushed themnt-reorg-galleries branch from004c5cc to87da4d5Compare

February 14, 2023 06:25

tacaswell added this to thev3.8.0 milestone

Feb 14, 2023

Copy link

Member

tacaswell commentedFeb 14, 2023

👍🏻 in principle.

jklymak force-pushed themnt-reorg-galleries branch 3 times, most recently from416364c to7fcc80aCompare

February 14, 2023 16:57

jklymak marked this pull request as ready for review

February 14, 2023 17:29

jklymak mentioned this pull request

Feb 14, 2023

DOC: start reorg explain#25218

Closed

6 tasks

Copy link

Member

timhoffm commentedFeb 15, 2023

"examples" is a better name than "gallery", because it's more semantic (alsogalleries/Gallery is awkward). Can we go the other way and add a http redirect from gallery to example to preserve existing links working, so that we can use "example" consistently.

Copy link

MemberAuthor

jklymak commentedFeb 15, 2023

The change here just makes the private name the same as the public. I'm not sure if there is a mechanism to change the public name. If there is, changing the private is just a one-line "git mv" and a few edit in the dev docs and the conf.py.

We could also keep the private and public names different (that was not really the point here) but I think it is needlessly confusing.

Copy link

Member

timhoffm commentedFeb 16, 2023

We could also keep the private and public names different

Slight preference for doing this if you want to move forward without going into "changing the public name" right now. Having "gallery" as the internal name and url, but resulting in a page titled "Examples" which is under the menu entry "Examples" is still confusing. The only consistent naming option is all "examples".

github-actionsbot added the status: needs rebase label

Feb 16, 2023

jklymak mentioned this pull request

Feb 20, 2023

[CI] Skip tests on doc-only changes#25261

Merged

6 tasks

jklymak force-pushed themnt-reorg-galleries branch from7fcc80a to20eda30Compare

February 20, 2023 16:36

github-actionsbot removed the status: needs rebase label

Feb 20, 2023

Copy link

MemberAuthor

jklymak commentedFeb 20, 2023

The structure is nowgalleries/examples ->doc/gallery. Redirectingdoc/gallery ->doc/examples via http redirect requires getting into the setup mechanisms for our web host

jklymak added the status: needs review label

Feb 20, 2023

Copy link

Member

ksunden commentedFeb 21, 2023

Unfortunately#25270 conflicted the animation examples (and a couple README's)... should be relatively trivial (probably for all of the animation ones at least it is the grammatical change fromgenerate togenerated on the note about the html viewer that was made on the backport.)

Also, am I misremembering the call? I thought the conclusion of that conversation was that we preferred the term "examples" over "gallery" for the repo paths (and desired doing redirects to make the url match as "examples", rather than its current "gallery", though I can acknowledge that much may be out of scope for now).

The extra level of heirarchy is fine, and I don't mind that being called "galleries", but for those called "examples" now, keeping it so was my impression of the consensus.

jklymak force-pushed themnt-reorg-galleries branch from20eda30 to69cc6a1Compare

February 21, 2023 21:05

Copy link

MemberAuthor

jklymak commentedFeb 21, 2023

Sorry, I somehow messed up the last push.

jklymak force-pushed themnt-reorg-galleries branch 2 times, most recently from03197dc toc5c7eebCompare

February 22, 2023 18:30

jklymak marked this pull request as draft

February 22, 2023 18:30

jklymak force-pushed themnt-reorg-galleries branch fromc5c7eeb tocca402eCompare

February 22, 2023 18:50

jklymak marked this pull request as ready for review

February 22, 2023 19:54

jklymak force-pushed themnt-reorg-galleries branch fromcca402e toc1fad31Compare

February 22, 2023 22:15

Copy link

Member

QuLogic commentedFeb 23, 2023

It looks like.github/workflows/tests.yml,.gitignore,.pre-commit-config.yaml andpyproject.toml need updating.

jklymak force-pushed themnt-reorg-galleries branch fromc1fad31 toddc4079Compare

February 23, 2023 04:28

Copy link

MemberAuthor

jklymak commentedFeb 23, 2023

It looks like.github/workflows/tests.yml,.gitignore,.pre-commit-config.yaml andpyproject.toml need updating.

Phew, we sure repeat the same exceptions in a lot of places....

jklymak force-pushed themnt-reorg-galleries branch fromddc4079 to01cc2caCompare

February 23, 2023 15:29

Copy link

MemberAuthor

jklymak commentedFeb 23, 2023

The pre-commit isort block doesn't hitgalleries/plot_types. I didn't fix that because that directory fails isort, and didn't want to sidetrack this...