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.

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

Initial sphinx-gallery #609

Merged
merged 9 commits into from
Oct 24, 2024
Merged

Initial sphinx-gallery #609

merged 9 commits into from
Oct 24, 2024

Conversation

maximelucas
Copy link
Collaborator

@maximelucas maximelucas commented Oct 23, 2024

Addressing #583: initial try for a new gallery that's automatically generated from individual small python scripts.

Right now it's accessible through a new item "Gallery of examples" in the menu. I think it could ultimately be merged with our current Gallery by porting the existing plots into this new format.

Let me know if you like it, and we can see what to add (now or later).

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.24%. Comparing base (139a2bc) to head (d6a9d7d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #609   +/-   ##
=======================================
  Coverage   93.24%   93.24%           
=======================================
  Files          62       62           
  Lines        4735     4735           
=======================================
  Hits         4415     4415           
  Misses        320      320           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nwlandry
Copy link
Collaborator

Looks great @maximelucas!! Only comment is that I would remove the "Gallery" tab and examples and remove the "Algorithms" subsection.

Copy link
Collaborator

@nwlandry nwlandry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Only comment is wow there are a lot of files --- how does this compare to other libraries?

@maximelucas
Copy link
Collaborator Author

maximelucas commented Oct 23, 2024

Thanks Nich! Most of the files were autogenerated, I removed them.

Also for the record I only needed to:

  • add a few lines to conf.py
  • add single .py files for each example

Basically that's it. And to add new examples, we just need to add single plot_*.py files in the examples/ folder and its subfolders.

I put the Gallery visible in the menu too (moved away from dropdown). If you like it I'll merge.

@nwlandry
Copy link
Collaborator

Looks great! When you merge this PR, can you open an issue to add in some more examples and can you also make sure that the unused pictures and files from the old gallery are deleted?

@maximelucas maximelucas merged commit d36c5a7 into main Oct 24, 2024
24 checks passed
@maximelucas maximelucas deleted the gallery branch October 24, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants