-
Notifications
You must be signed in to change notification settings - Fork 116
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
Open
remrama
wants to merge
17
commits into
raphaelvallat:master
Choose a base branch
from
remrama:pydata-theme
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
+ 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). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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).