Skip to content

Choose approach for base theme #22

Description

@flying-sheep

Description of feature

Concerns:

  • Layout: needs to be clean and easy to use, e.g. using simply sphinx toctrees
  • Extensions: we need to support MyST notebooks, Sphinx-Design, and maybe more plugins
  • Dark mode: has gone through 3 eras, both the theme and plugins need to agree for support (ipywidgets sucks at this). This is the perfect approach: Dark mode like it’s 2024 pydata/pydata-sphinx-theme#2484
  • Color system: colors shared with the website, available as CSS variables. see pydata theme docs about this.

Ideas:

Theme Pro Con
PyData Relatively modern CSS makes customization nice: CSS variables, media queries Looks wonky, header gets big, unclear what belongs into header and what into sidebar[^1]
Book Looks good and clean out of the box, otherwise see PyData (it customizes it) Slow response to isses, we’d customize a customization, so more complex overrides
Other There might be one that’s perfect? Most don’t have good notebook/MyST support, might use a dark mode scheme not supported by extensions

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions