-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Consolidate and move examples out of pylab #8266
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
Conversation
This probably should make contact with http://matplotlib.org/users/annotations.html |
That's a good idea @tacaswell , latest push has a reference to the tutorial in the intro paragraph. It's a little hard for me to see how this will render on the MPL website because it appears that sphinx-gallery isn't actually set up to build yet... |
On that matter, maybe we should merge the sphinx-gallery PR sooner than later (though i am slightly hesitant to do this just now). |
why not merge a PR with sphinx-gallery generating on a hidden page first (e.g. not linked in |
I would be happy with merging sooner rather than later and having an 'old' section that things get moved out of. |
Cool - in the meantime lemme know if this looks OK and I can remove the other annotation examples (since this has all of the same information in one package). If there need to be edits made to the gallery render then I'm happy to make those changes when the time comes. |
4ed0106
to
8df5002
Compare
revived this PR and added some other consolidated examples...maybe @story645 has thoughts? |
(I don't believe that travis failures are due to this PR) |
It's kinda hard to follow 'cause there are so many files. Preliminary thought is nothing is jumping out as being messy. |
Yeah - there are lots of changed files basically because some links got broken and had to be changed. It's not really adding anything new, just consolidating examples into one thing instead of multiple things. The biggest drawbacks I can see to this PR is that some of these might be better as tutorials etc, but I don't have the bandwidth to do a full overhaul and think it's better to consolidate as a first step anyway. LMK what you think! |
Agree with you on consolidating first and then worrying about what should be a tutorial later. Do you have a list of which examples got consolidated down to what? |
It's something like:
|
So long as nothing got removed and it was all shifting, I'm +1 on merging |
5bfd9cb
to
37995b9
Compare
latest push is just a rebase on 2 files that were slightly changed, but the doc-relevant tests were passing... |
ping @story645 :) (unless we need another person to look b4 merge?) |
ping @tacaswell to sign off on the consolidation? |
found a broken image link in there! latest push should fix it and then this PR is ready to go from my end... |
Failing travis test isn't doc related...think this is ready to go @story645 ? |
Sorry, I agree with you but a previous disagreement about a deleted doc makes me gunshy about merging any major doc overhauls (and while this doesn't delete, it does move things) without at least one more devs approval. |
The failing test is in a file that's changed in this PR, so I think it is related. Will review other stuff later. |
ccf4005
to
fbd6de5
Compare
@QuLogic you're right - just saw that, it was a PEP error (no blank line at end of file). I disregarded the test because I thought it was one of the non-doc ones that errors all the time. Latest commit fixes that |
That's great, I am +1000 on making tests more reliable :-) |
fbd6de5
to
95be2dd
Compare
looks like tests passing now @QuLogic ! |
How easy would it be to split this up into several smaller PRs? I've having trouble reviewing it because there are so many changes. |
To be honest, I would really prefer avoiding this. For better and worse PRs get merged rather slowly in matplotlib and I have already sunk a ton of time in the docs these last months, so I don't have the bandwidth to oversee a bunch of new pull requests. For this reason I'd rather lump a bunch of changes together when it's just rearranging stuff etc. This doesn't create any new content, it's just taking examples numbered I agree with you that any really meaningful changes to content, etc should be done in separate PRs. |
@choldgraf, Thank you! This looks to me like low-risk progress, so I merged it. |
@efiring thanks! If this introduced something weird somewhere feel free to ping me and I'll patch it. |
This consolidates a number of examples in the
pylab
examples folder. Basically it's just taking examples where there wasXXX_demo1
,XXX_demo2
etc, and turning them into a single sphinx-gallery demo. It also moves a couple of them into more appropriate folders (e.g., barplots go from pylab -> statistics).related to #8564 though it's not creating tutorials per-se. I think some of these examples could be converted to tutorials one day, but I think this is a good first step.