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

Use Sphinx RTD Theme #25614

Closed
wants to merge 4 commits into from
Closed

Use Sphinx RTD Theme #25614

wants to merge 4 commits into from

Conversation

WillAyd
Copy link
Member

@WillAyd WillAyd commented Mar 9, 2019

TOC on the left hand side is pinned during navigation and also expandable/collapsible

image

image

@WillAyd WillAyd added the Docs label Mar 9, 2019
@codecov
Copy link

codecov bot commented Mar 9, 2019

Codecov Report

Merging #25614 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #25614      +/-   ##
==========================================
- Coverage   91.26%   91.26%   -0.01%     
==========================================
  Files         173      173              
  Lines       52968    52968              
==========================================
- Hits        48340    48339       -1     
- Misses       4628     4629       +1
Flag Coverage Δ
#multiple 89.83% <ø> (ø) ⬆️
#single 41.71% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 87.57% <0%> (-0.1%) ⬇️

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 cc4a7e5...fe39855. Read the comment docs.

@codecov
Copy link

codecov bot commented Mar 9, 2019

Codecov Report

Merging #25614 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #25614      +/-   ##
==========================================
- Coverage   91.26%   91.26%   -0.01%     
==========================================
  Files         173      173              
  Lines       52968    52968              
==========================================
- Hits        48340    48339       -1     
- Misses       4628     4629       +1
Flag Coverage Δ
#multiple 89.83% <ø> (ø) ⬆️
#single 41.71% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/util/testing.py 87.57% <0%> (-0.1%) ⬇️

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 cc4a7e5...a97bb23. Read the comment docs.

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Mar 11, 2019

Should we be re-styling the website at the same time as the docs? Or would people be OK with changing those at different times?

@WillAyd have you looked at the http://pandas-docs.github.io/pandas-docs-travis/user_guide/style.html page with this theme? Does it look OK?

@WillAyd
Copy link
Member Author

WillAyd commented Mar 14, 2019

@TomAugspurger sorry just seeing this now. That theme looks OK to me!

I'm not terribly tied to the this PR but opened because:

  1. I think it's regardless an improvement over the nature theme
  2. Would be entirely external to pandas (no theme vendoring or changes required)
  3. Has a better dropdown on the left (i.e. doesn't require navigating to page to expand options)
  4. It's easy

If there's not an appetite for it though certainly can close

@WillAyd
Copy link
Member Author

WillAyd commented Mar 14, 2019

Should we be re-styling the website at the same time as the docs? Or would people be OK with changing those at different times?

To answer this explicitly I think different times is fine. I don't see a super tight harmony between existing site and docs (though more than RTD) and wouldn't want to try a super big change at once.

@TomAugspurger
Copy link
Contributor

That's fair.

Thoughts on holding off on this till we hear if we line up someone to work on our docs as part of that NUMFocus grant?

@WillAyd
Copy link
Member Author

WillAyd commented Mar 14, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: more modern sphinx theme
2 participants