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

Enhance ordering of tutorials in sphinx gallery #1399

Merged
merged 8 commits into from
Feb 3, 2022
Merged

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Aug 14, 2021

Motivation

Sphinx gallery currently sorts tutorials within a section based on file size. This order is not very intuitive.

Changes in this PR

  • Updated sorting of tutorials within a section to be alphabetical based on the section headings
  • Updated tutorial headings as necessary to use consistent capitalization and be consistent with the icons
  • Minor changes to headings to improve ordering
  • Updated ophys and icephys tutorial to use relative width for figures to ensure consistent rendering and avoid too large images in LaTeX

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@codecov
Copy link

codecov bot commented Aug 14, 2021

Codecov Report

Merging #1399 (1849790) into dev (e484bfd) will decrease coverage by 0.04%.
The diff coverage is n/a.

❗ Current head 1849790 differs from pull request most recent head e56c3d2. Consider uploading reports for the commit e56c3d2 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #1399      +/-   ##
==========================================
- Coverage   77.31%   77.26%   -0.05%     
==========================================
  Files          37       37              
  Lines        2715     2714       -1     
  Branches      450      450              
==========================================
- Hits         2099     2097       -2     
  Misses        535      535              
- Partials       81       82       +1     
Impacted Files Coverage Δ
src/pynwb/icephys.py 89.52% <0.00%> (-0.35%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e484bfd...e56c3d2. Read the comment docs.

@oruebel oruebel requested a review from rly August 14, 2021 21:58
@oruebel
Copy link
Contributor Author

oruebel commented Aug 20, 2021

@rly this is ready for review

@rly
Copy link
Contributor

rly commented Feb 2, 2022

@oruebel Is this ready to merge? If so, please Squash and Merge. Thanks

@rly rly mentioned this pull request Feb 3, 2022
10 tasks
@oruebel oruebel merged commit d2a06e1 into dev Feb 3, 2022
@oruebel oruebel deleted the enh/tutorial_order branch February 3, 2022 08:33
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