New theme: sphinx-immaterial

[dolfinus]

sphinx-material theme is not being updated since 2021. It's actually quite old fork of mkdocs-material theme, and the divergence happened a long time ago.

The most recent fork of original theme is now a sphinx-immaterial. It is actively maintained, and has a lot of new features missing in sphinx-material. https://jbms.github.io/sphinx-immaterial/

Example of a project which uses this theme: galois https://galois.readthedocs.io/en/latest/

It will be great if this new there will be added to sphinx-themes. And maybe even replace outdated sphinx-material

[shirou]

Thank you for the information. It looks good! However, from the README,

WARNING: This theme is still in beta. While it is already very usable, breaking changes will still be made prior to the 1.0 release.

I would suggest that we wait a little longer before the release. How do you think?

[dolfinus]

Personally, I prefer to use beta version instead of some unmaintained project.

[pradyunsg]

Thanks for filing this! I think I'll split this issue into two pieces:

• Removing the outdated sphinx-material theme from the website.
• Adding the new sphinx-immaterial theme to the website.

The first one is probably a no-brainer at this point and a PR would be welcome (I might just file one myself). The second one is the point where I agree with @shirou -- until that note is removed (ideally, through a 1.0 being reached), I'm not particularly comfortable listing it on the site.

FWIW, I've been aware of the sphinx-immaterial theme since it's inception, and have vaguely kept track of it to occasionally check if they've reached 1.0 (https://github.com/pradyun/materialism was my first foray into Sphinx themes, so mkdocs-material but in Sphinx is an idea that I like 😉).

[LecrisUT]

Often times I see projects that have been stable and usable for a long time but didn't bump to 1.0. I think it would be helpful to include such themes, at least in a non-released section.