Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use sphinx-gallery for doc examples #164

Closed
sauln opened this issue Apr 6, 2019 · 0 comments
Closed

Use sphinx-gallery for doc examples #164

sauln opened this issue Apr 6, 2019 · 0 comments
Labels
docs Documentation related issues

Comments

@sauln
Copy link
Member

sauln commented Apr 6, 2019

The documentation examples are currently just a few images while the examples in the examples folder provide executable code. We should be able to use sphinx-gallery to run the code in the example scripts and display the results.

This will look much nicer than the current system and will address suggestions in openjournals/joss-reviews#1315
@sauln sauln added the docs Documentation related issues label Apr 6, 2019
@sauln sauln changed the title [Docs] Use sphinx-gallery for doc examples Use sphinx-gallery for doc examples Apr 6, 2019
@sauln sauln mentioned this issue Apr 6, 2019
Closed
4 tasks
@sauln sauln closed this as completed Nov 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation related issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sauln