Skip to content

sphinx-material is no longer maintained and does not work with Python 3.12 #262

@ugognw

Description

@ugognw

sphinx-material cannot be installed in a Python 3.12 environment since it uses the SafeConfigParser class which was moved to ConfigParser in Python 3.12. Further, the owner is unlikely to put any real effort into maintaining the project moving forward, which does not bode well for compatibility with newer Python versions. However, the author swears by the very similar sphinx-immaterial theme, so that may be a potential alternative.

AFAICT, the configuration is nearly identical. Something like the following changes are required in html_theme_options (in docs/conf.py):

  • "base_url" -> "site_url"
  • "nav_title" -> "toc_title"
  • "color_primary"/"color_accent" -> "palette": { "primary": "blue", "accent": "light-blue" }

I have yet to check that the docs built without issue with this new theme, however.

Metadata

Metadata

Assignees

Labels

docsdocumentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions