-
Notifications
You must be signed in to change notification settings - Fork 118
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
Overhaul docs with PyData Sphinx Theme #194
Conversation
+ No longer need tracking on this repo branch
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #194 +/- ##
=======================================
Coverage 77.24% 77.24%
=======================================
Files 13 13
Lines 2659 2659
Branches 324 324
=======================================
Hits 2054 2054
Misses 568 568
Partials 37 37 ☔ View full report in Codecov by Sentry. |
The tests should be fine with the one failure. The docs workflow will fail here until some settings are changed that allow the docs to publish (it works on my fork). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Phenomenal work @remrama, as always! I'll merge the PR now.
This PR addresses #179 by changing the YASA docs from bootstrap theme to pydata theme. I made some other major changes along the way, mostly steps to reduce the overall size of the YASA repository. All could be undone if they are not preferred approaches.
I still want to make a few more changes, but I wonder if this PR could be merged first? I think the 5 completed tasks are probably enough to process at once here.
sphinxbuild
command serves the same function and is more universal (def easier on my end). I updated the build instructions on Contributing page to match.gh-pages
branch. It requires very minimal setup.Tasks I think should be finished in separate PRs:
Update color scheme to match OG YASA siteMove notebooks onto the docs site via sphinx-gallery (used by numpy, matplotlib, pandas, mne, etc.)Add version switcherReview text of all pagesThe site generated from this branch can be temporarily viewed at https://remrama.github.io/yayasa (will get deleted after merge).