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 a new sphinx theme for the website #654

Merged
merged 4 commits into from
Jul 11, 2023
Merged

Use a new sphinx theme for the website #654

merged 4 commits into from
Jul 11, 2023

Conversation

karlch
Copy link
Owner

@karlch karlch commented Jul 6, 2023

Switch from sphinx-bootstrap-theme to pydata-sphinx-theme.

Reasons for the switch:

Reasons against the switch:

  • Change of "feel"

I think the benefits outweight the cons quite clearly, but will leave this one open for a few days so anyone interested can chime in.

Quick screenshots of the new look, so one doesn't have to build it:

Startpage - light
scrot-2023-07-06_21:56:25

Screenshots - light
scrot-2023-07-06_21:56:42

Documentation - dark - showcases the navigation on the right
scrot-2023-07-06_21:57:00

The sphinx bootstrap theme has been unmaintained / not updated for quite
a while. This theme works with more recent sphinx and has a few other
goodies:

- nice icons in the navbar
- dark / light mode
@jcjgraf
Copy link
Contributor

jcjgraf commented Jul 8, 2023

I definitely prefer the new one as it looks much cleaner. Also the On this Page scroll bar is very usefully (actually, I only realized while comparing it to the old one, that the Page dropdown served that purpose on the old website). And the formatting of the commands I also like much more.
Also the search functionality is very useful (was there something like that on the old one?), though it is not perfect (yet?). It would be nice if it also showed an extract of the matching text, and not just the name of the page containing a match.

@karlch
Copy link
Owner Author

karlch commented Jul 10, 2023

Thanks for your feedback!

Seems like they are aware of the search limitations (c.f. pydata/pydata-sphinx-theme#795 and pydata/pydata-sphinx-theme#202), but progress has been limited over the past years. However, the discussion picked up steam semi-recently, so maybe we are lucky 🤞

@karlch karlch merged commit bef5d71 into master Jul 11, 2023
@karlch karlch deleted the new-website-theme branch July 11, 2023 19:13
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