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

Switch to the pydata sphinx theme #259

Merged
merged 3 commits into from
Feb 1, 2024

Conversation

mwcraig
Copy link
Contributor

@mwcraig mwcraig commented Jan 14, 2024

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

@mwcraig mwcraig marked this pull request as draft January 14, 2024 19:07
@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

The test failure here is fixed in #258

@mwcraig mwcraig requested a review from JuanCab January 15, 2024 15:00
@mwcraig mwcraig force-pushed the pydata-sphinx-theme branch from eac5898 to 9fc662c Compare January 15, 2024 15:06
@mwcraig mwcraig marked this pull request as ready for review January 15, 2024 15:07
@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

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 😀

@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

To see a rendered version of the documentation click on the "Details" link for the ReadTheDocs check.

@JuanCab
Copy link
Contributor

JuanCab commented Jan 15, 2024

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?

Copy link
Contributor

@JuanCab JuanCab left a 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.

@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

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?

I meant this -- the documentation gets built on ReadTheDocs for every pull request 😀:

Switch_to_the_pydata_sphinx_theme_by_mwcraig_·_Pull_Request__259_·_feder-observatory_stellarphot

@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

dark background which made seeing the inheritance diagrams difficult. Might need some CSS tweaked.

Looking into it...

@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

I'm seeing legible inheritance diagrams on RTD, though they look different to me locally, investigating that...

stellarphot_Documentation_—_stellarphot_v0_1_dev222_g9fc662c_d20240115

@mwcraig
Copy link
Contributor Author

mwcraig commented Jan 15, 2024

No idea why the build looks the way it should on RTD but not locally 🤷‍♂️

@mwcraig
Copy link
Contributor Author

mwcraig commented Feb 1, 2024

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.

@mwcraig mwcraig merged commit fe0c295 into feder-observatory:main Feb 1, 2024
9 checks passed
@mwcraig mwcraig deleted the pydata-sphinx-theme branch February 8, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants