search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.39k stars 2.09k forks source link

Modernising the `basic` theme #10646

Open AA-Turner opened 2 years ago

AA-Turner commented 2 years ago

The basic theme is showing its age -- non-responsive, and not really a great advert for Sphinx out-of-the-box.

Improving it is tricky though, as almost every theme relies on it through Jinja templating.

I see two options:

1) Try and modernise the theme, whilst preserving compatability as much as humanly possible. 2) Start over with basic v2

(1) is more attractive as the benefits flow through, but perhaps a lot more work.

At some point we should also evaluate the stable of default themes and if that needs a refresh, but I think the basic work is more pressing.

A

humitos commented 2 years ago

I know that @pradyunsg and @choldgraf have had some good discussions about a newer basic theme and they created https://github.com/pradyunsg/sphinx-basic-ng/. It may be useful to take those conversations and code as a base to decide the direction of this work in case it can be reused.

tk0miya commented 2 years ago

I don't have knowledge of modern HTML. So I'm not sure which option is better. But +1 for improvement if somebody will help us.

At some point we should also evaluate the stable of default themes and if that needs a refresh, but I think the basic work is more pressing.

All bundled themes are not maintained well. So it might be time to unbundle.

pradyunsg commented 2 years ago

I'd be more than happy to help out with this -- see also https://github.com/sphinx-doc/sphinx/issues/10419#issuecomment-1181695008 where I responded to the suggestion of borrowing the new things from basic-ng!

AA-Turner commented 2 years ago

Thank you Pradyun!

A