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

Try switching themes #61

Merged
merged 19 commits into from
Sep 4, 2023
Merged

Try switching themes #61

merged 19 commits into from
Sep 4, 2023

Conversation

IAlibay
Copy link
Member

@IAlibay IAlibay commented Sep 3, 2023

Sorry I didn't want to steal work, I just wanted to try this out a bit and get a feel for how it worked.

In this PR:

  • Switching themes
  • Deleting a bunch of unused stuff
  • Fixing all the doc build warnings

@IAlibay
Copy link
Member Author

IAlibay commented Sep 3, 2023

Looks like we need to unpin sphinx, that might break the datatables stuff, that'll be interesting to fix. fixed

@IAlibay
Copy link
Member Author

IAlibay commented Sep 3, 2023

So fun upside of this - the datatable still shows, downside is that it's now horribly squashed looking. fixed

body {
font-family: 'PT Sans', Helvetica, Arial, 'sans-serif';
font-size: 17px;
.dataTables_wrapper.no-footer .wy-table-responsive {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This from seems to do the trick in making sure the table isn't horribly squashed: readthedocs/sphinx_rtd_theme#1287 (comment)

I suspect this isn't something we'd want to upstream since we don't really use dataTables anywhere else in the ecosystem?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm I reckon we should upstream this! It's unlikely it'd affect anything else and if we do want to use datatables in the future, I assume we'd want to apply the same styling. Also it seems like a pity to keep this file just for this part.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added as a commit for now -- of course I can revert if you disagree!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers, let's see if that does the trick.

lilyminium added a commit to MDAnalysis/mdanalysis-sphinx-theme that referenced this pull request Sep 3, 2023
@IAlibay
Copy link
Member Author

IAlibay commented Sep 4, 2023

Alright, thanks @lilyminium, I think this all works? I'll avoid merging this until you give us the thumbs up that it's good to go ahead (probably post merge of https://github.com/MDAnalysis/mdanalysis-sphinx-theme/compare/update-theme).

@lilyminium
Copy link
Member

Thanks @IAlibay! It LGTM but I agree it's a good idea to wait until https://github.com/MDAnalysis/mdanalysis-sphinx-theme/compare/update-theme is in -- I'll make a new release at that point too, so we can avoid pinning to development branches :D I'll check how the docs look on some other core repos first but otherwise I think we're pretty close, the mdakit and smaller repos have less complicated docs so shouldn't require too many theme updates.

@IAlibay
Copy link
Member Author

IAlibay commented Sep 4, 2023

Thanks for all the work here @lilyminium - sorry I can't be more useful, it is something I would have loved to spend more time getting to grips with.

@IAlibay IAlibay closed this Sep 4, 2023
@IAlibay IAlibay reopened this Sep 4, 2023
@IAlibay
Copy link
Member Author

IAlibay commented Sep 4, 2023

Works great!

@IAlibay IAlibay merged commit 056353e into main Sep 4, 2023
2 checks passed
@IAlibay IAlibay deleted the mda-sphinx-theme branch September 4, 2023 07:42
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