Skip to content
This repository was archived by the owner on Dec 22, 2021. It is now read-only.

Setup minimal gallery for Fatiando#282

Merged
leouieda merged 24 commits into
masterfrom
sphinx-gallery
Jun 20, 2016
Merged

Setup minimal gallery for Fatiando#282
leouieda merged 24 commits into
masterfrom
sphinx-gallery

Conversation

@leouieda
Copy link
Copy Markdown
Member

@leouieda leouieda commented May 9, 2016

Uses sphinx-gallery to setup a minimal gallery (like the maptlotlib gallery). The idea is to create the basis for the gallery and fill it up with plots in other PRs (ideally with the help of other devs).

Continues the work started in #266.

I posted a temporary example to fatiando.org/tmp-docs so others can have a look.

Checklist:

  • Code and docs have been spellchecked
  • Include new dependencies in doc/install.rst, requirements.txt, environment.yml, and README.rst
  • Documentation builds properly (run make docs locally)
  • Changelog entry (leave for last)
  • Building and pushing from TravisCI works
  • Include links to the gallery in the documentation (front-page, docs page, install)
  • At least one example for gridder, mesher, vis, gravmag and seismic

Notification for @fatiando/core-devs

leouieda added 3 commits May 9, 2016 20:23
I'll try them out later for the tutorials. But I'll probably try to use
notebooks for that so that they can run in Binder.
@leouieda leouieda added the docs label May 9, 2016
@leouieda leouieda added this to the 0.5 milestone May 9, 2016
Need dev version of sphinx-gallery and a forced upgrade to pyface and
traits using pip. Also some magic done in Travis config (not tested)
@leouieda
Copy link
Copy Markdown
Member Author

Finally got Mayavi plots to work in the gallery: http://www.fatiando.org/tmp-docs/gallery/meshes_grids/prism_model.html

This will open the way for a model collection gallery in the future.

@eusoubrasileiro
Copy link
Copy Markdown
Contributor

Uow this is getting prettier and prettier!! just fixed your broken link, dont get upset hehe

@leouieda
Copy link
Copy Markdown
Member Author

@eusoubrasileiro oops. That's what I get for having 20 tabs open. Thanks!

I just need to test if the docs build properly on TravisCI now. I'll leave the gallery with only one example from each package as a guide for future work. We can fill it up on subsequent PRs so it's not concentrated work. New PRs can already add their scripts here instead of the cookbook.

@leouieda
Copy link
Copy Markdown
Member Author

OK, this is done. There are only 1-2 examples per package right now. We'll need to add more later but this gets us the infrastructure needed.

@leouieda leouieda merged commit 4055db6 into master Jun 20, 2016
@leouieda leouieda deleted the sphinx-gallery branch June 27, 2016 22:21
@leouieda leouieda mentioned this pull request Jun 28, 2016
11 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants