-
Notifications
You must be signed in to change notification settings - Fork 12
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
Switch to the pydata sphinx theme #259
Conversation
The test failure here is fixed in #258 |
Astropy, and. many, many other projects use this theme these daya.
eac5898
to
9fc662c
Compare
Rebased to pull in #258. I think further changes should wait until documentation is actually drafted. It looks like the pydata Sphinx theme has lots of customization options, for better or worse.... Best thing is that it has a dark mode 😀 |
To see a rendered version of the documentation click on the "Details" link for the ReadTheDocs check. |
Can you clarify what you mean here? I created a copy of the docs with tox but did you want me to check something else? |
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.
The only issue I see is when I brought up the HTML pages generated using tox -e build_docs
, they had a dark background which made seeing the inheritance diagrams difficult. Might need some CSS tweaked.
Looking into it... |
No idea why the build looks the way it should on RTD but not locally 🤷♂️ |
I'm going to merge this so that I can do some documentation work today or tomorrow. Still not quite sure what is up with the inheritance diagrams locally, but since it works on RTD I figure that is good enough. |
This theme was recently adopted by astropy and is pretty widely used by other large projects. Seemed better to switch pre-release rather than post-release.
Marking this as a draft for now because
I need to copy over some CSS from astropy, I think...Copied that over, still want to look at how they do the card setup here: astropy.rtfd.io