-
Notifications
You must be signed in to change notification settings - Fork 548
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
[REVIEW] Change docs theme to pydata-sphinx
theme
#4985
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
pydata-sphinx
themepydata-sphinx
theme
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.
I ran this locally and it really looks great to me overall. I like that the GitHub and RAPIDS twitter links are right on the top and I was having fun playing with the light/dark color modes. The code all appears to display nicely and the source links work.
The only thing I would change is to shorten the top-level section headings just a tad. Small things like removing "cuml" (since cuml is already displayed on the left and users already know the docs are for cuml) from section headings on the top could help make things easier to consume.
We can discuss that stuff further, though, and open follow-up PRs if we feel it should be changed.
Do we need this file anymore? https://github.com/rapidsai/cuml/blob/branch-22.12/conda/environments/builddocs_py36.yml [Can discuss in follow ups] |
Not at all, I've used |
Yup, can shorten those. Will do it here. |
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.
@galipremsagar just holding this PR open while you make the changes so it doesn't accidentally get merged.
@cjnolet @beckernick Addressed your reviews and this should be ready for another look. The top bar will now look much cleaner, let me know what you think. |
rerun tests |
@gpucibot merge |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## branch-22.12 #4985 +/- ##
===============================================
Coverage ? 79.60%
===============================================
Files ? 184
Lines ? 11698
Branches ? 0
===============================================
Hits ? 9312
Misses ? 2386
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Similar to rapidsai/cuml#4985, this PR changes the docs theme for `raft` to be in-line with rest of the rapids docs theme. Authors: - GALI PREM SAGAR (https://github.com/galipremsagar) Approvers: - Corey J. Nolet (https://github.com/cjnolet) - AJ Schmidt (https://github.com/ajschmidt8) URL: #1026
This PR: - [x] Switches the python docs theme to `pydata-sphinx-theme` to be uniform with rest of the `rapids` python docs. - [x] Fixes typos - [x] Fixes a number of formatting and alignment issues in docstrings. - [x] Discuss with cuml team on how(if any) and where things should be placed. Authors: - GALI PREM SAGAR (https://github.com/galipremsagar) Approvers: - Corey J. Nolet (https://github.com/cjnolet) - AJ Schmidt (https://github.com/ajschmidt8) URL: rapidsai#4985
This PR:
pydata-sphinx-theme
to be uniform with rest of therapids
python docs.