Add gallery of examples to documentation #4734
Conversation
|
Have you tested this on readthedocs? I am having memory consumption issues on their build service. |
|
@Cadair I haven't, but we also haven't asked those nice people yet for more resources |
|
BTW: to anyone following, my thesis is due next week so I haven't worked on this since getting back from PyAstro16. It's not far from being complete -- there are a few remaining issues for me to solve / submit PR's to sphinx-gallery itself but those shouldn't take too much time. |
|
Dr @adrn (congrats! 🎉 ) - do you think it would be possible to finish this up by the end of this week so that we can include it in the 1.2 docs? (feature freeze is this Friday) |
|
Thanks @astrofrog! Yea, totally -- I'm back at my desk today. |
|
My feeling from PyAstro16 is that people don't like Astropy fitters and want to use Sherpa fitters (or something like that). I thought someone wrote an example like that using MCMC during PyAstro16, no? I cannot seem to find it in the Google doc but I remember hearing about it. That would be a good example to include here. |
|
@adrn - But there wasn't any new helpers release yet. |
|
Oh right - sorry I thought I remembered seeing a 1.1.3 release. oops! |
|
In that case, I think this is ready for review. cc @astrofrog @kelle |
|
@adrn - could you rebase this and add a changelog entry? |
| @@ -58,6 +58,7 @@ User Documentation | |||
| overview | |||
| install | |||
| getting_started | |||
| auto_examples/index | |||
There was a problem hiding this comment.
If you want to put it here, it should only add one entry to the TOC called 'Tutorials' or 'Gallery of Tutorials'. At the moment it adds two obscure astropy.coordinates and astropy.io entries.
|
@adrn - just had a look at this. Awesome work! I really hope this will open the floodgates for user-contributed examples now. It makes it really easy to add examples and makes the results highly visible in a nice format. |
|
@astrofrog RE: changelog, should I add to "Other changes and additions" or make a new category for documentation changes? @taldcroft Thanks! Yea, I'm really hoping this makes examples more visible and easier for people to contribute. |
|
@adrn - 'other changes' is fine, I can see if there is enough to make a new section when I tidy up the changelog |
|
@adrn - can you try just adding a commit to this PR to update the helpers submodule to the latest helpers? I think that will fix the build_succeeded issue (astropy/astropy-helpers#223) without forcing us to do a helpers release now just for that. |
|
(To check this I just started a quick run on my travis: https://travis-ci.org/eteq/astropy/builds/130121818) |
|
Note that it all worked on my branch where I just added one more "update the helpers to master" commit: https://travis-ci.org/eteq/astropy/builds/130121818 . @adrn, if you can get to this now (and the changelog entry) I'm happy with merging once those are in and not waiting for this to run. |
Add gallery of examples to documentation
|
Thanks @eteq for finishing up the final steps (I was busy last night) and thanks @astrofrog for reviewing! |
Work in progress
This is the result of discussions at Python in Astronomy 2016 about the state of astropy-tutorials. We decided to implement a trial version of a sphinx-gallery of examples in the astropy documentation similar to the scikit-learn examples gallery.
Here's a live demo of the gallery in the astropy docs
Outstanding issues / tasks:
Some strange issues with sphinx-gallery:
openedmerged a PR to fix: Remove extra indentation sphinx-gallery/sphinx-gallery#111)Mouseover for gallery thumbnails doesn't always show the name of the example (not going to be fixed before this PR is merged)(seems to be resolved)openedmerged a PR to fix: Allow user to choose thumbnail image sphinx-gallery/sphinx-gallery#114)TODO items to be handled after this PR:
cc @kelle