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 #583

Closed
maximelucas opened this issue Sep 7, 2024 · 0 comments
Closed

use Sphinx-gallery #583

maximelucas opened this issue Sep 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers improve Make an existing feature better

Comments

@maximelucas
Copy link
Collaborator

To improve the Gallery of our online docs, Sphinx-gallery seems like the way to go.

It's used for example by Matplotlib and NetworkX.

It works by generating a Gallery from a collection of pure python files that are executed to produce drawings.
I think it's a good idea to populate our gallery with more simple examples that people can quickly browse (see NetworkX).
We could already take many examples from the tutorials.
@maximelucas maximelucas added documentation Improvements or additions to documentation improve Make an existing feature better labels Sep 7, 2024
@nwlandry nwlandry added the good first issue Good for newcomers label Oct 21, 2024
@maximelucas maximelucas mentioned this issue Oct 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers improve Make an existing feature better
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@maximelucas @nwlandry