grackle-project / grackle

The Grackle chemistry and cooling library for astrophysical simulations and models.
Other
26 stars 50 forks source link

Updating the website theme - improving appearance of tables #219

Closed mabruzzo closed 4 months ago

mabruzzo commented 4 months ago

I wanted to briefly gauge receptiveness to updating the website theme. It's unclear to me whether this something we simply inherited and haven't changed from Enzo or something people feel strongly about.

I've never been a huge fan of the theme current theme, 'agogo' (in particular, I don't think it places enough emphasis on warnings and notes). But the thing that prompted me to make this issue is the formatting of tables. In particular, PR #182 introduces a handful of tables and I strongly dislike the current formatting. Here are 2 examples from the preview read-the-docs builds for that PR here and here.

Honestly, in the absence of any strong opinions, I always like the readthedocs theme. Maybe I'm just used to it, but I always find it visually appealing.

If we feel strongly about using a built-in theme:

We could also consider some other 3rd party themes. If we were willing to entertain larger departures from the existing style, both Material and Bootstrap seem like slick options... (But they may require additional customization to get them to look nice)

gregbryan commented 4 months ago

I don't particularly love our current theme so would be happy to change. The readthedocs theme has always seemed nice to me.

brittonsmith commented 4 months ago

I'm happy to switch themes. ytree uses the sphinx_rtd_theme. I particularly like how it allows you to expand the table of contents. Here is an example of a table. I agree, it looks much better.

mabruzzo commented 4 months ago

I'm glad that there seems to be a consensus around sphinx_rtd_theme. I opened a PR to make this transition.