Skip to content

Add key navigation to docs #1668

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

Merged
merged 2 commits into from
May 16, 2025
Merged

Add key navigation to docs #1668

merged 2 commits into from
May 16, 2025

Conversation

prisae
Copy link
Member

@prisae prisae commented May 16, 2025

Summary

This PR enables moving forward/backward in the docs with the right/left arrow keys on the keyboard. I quite enjoy this feature in documentations that have enabled it.

If you want to see how it works, test it over at, e.g., https://empymod.emsig.xyz.

PR Checklist

  • Just a docs-configuration change, the PR checklist does mostly not apply.

@simpeg/simpeg-developers - ready for review.

@prisae
Copy link
Member Author

prisae commented May 16, 2025

Oh. I realized that the default was True, but it changed recently:
pydata/pydata-sphinx-theme#1100

So it apparently is against the "gold standard" of keyboard navigation. Too bad, I love it.

Anyway, I leave it for a short while open, curious to see what you think.

Copy link

codecov bot commented May 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.57%. Comparing base (55cfbfa) to head (abcfb76).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1668      +/-   ##
==========================================
- Coverage   86.19%   85.57%   -0.62%     
==========================================
  Files         420      405      -15     
  Lines       54931    53499    -1432     
  Branches     5124     5088      -36     
==========================================
- Hits        47350    45784    -1566     
- Misses       6163     6320     +157     
+ Partials     1418     1395      -23     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@santisoler
Copy link
Member

😮 I didn't know about this feature. Let's merge it!

@santisoler santisoler merged commit 0a4cf76 into simpeg:main May 16, 2025
6 of 18 checks passed
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