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

Setup minimal gallery for Fatiando #282

Merged
merged 24 commits into from Jun 20, 2016

Conversation

Projects
None yet
2 participants
@leouieda
Member

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 some commits May 9, 2016

Don't use the notebook like examples yet
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

Make Mayavi plots in gallery work
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

This comment has been minimized.

Member

leouieda commented May 10, 2016

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

This comment has been minimized.

Contributor

eusoubrasileiro commented May 10, 2016

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

@leouieda

This comment has been minimized.

Member

leouieda commented May 10, 2016

@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 added some commits May 10, 2016

Try to make travis push to tmp-docs
Was chaining three conditionals in bash if. Guess it's not Python after
all.
TRAVIS_PULL_REQUEST will never be "true"
It's set to false or the PR number. Need to check is != false.
Add placeholders for gallery sections
Number folders to choose the order they appear on the gallery (would be
alphabetical otherwise).
The inversion package doesn't do well w graphs
Doesn't make much sense to put it in the gallery. No pretty plots from
that package.
@leouieda

This comment has been minimized.

Member

leouieda commented Jun 20, 2016

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

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 70.432%
Details

@leouieda leouieda deleted the sphinx-gallery branch Jun 27, 2016

@leouieda leouieda referenced this pull request Jun 28, 2016

Open

Roadmap to 1.0 #102

2 of 11 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment