sphinx-theme-material

A material based sphinx theme


Keywords
sphinx, theme, material-design, python, sphinx-doc, sphinx-theme
License
GPL-3.0+
Install
pip install sphinx-theme-material==1.1.2

Documentation

Material theme

CI status PyPI PyPI - Status

This is a material based sphinx theme. To use, first install the package:

pip3 install -U sphinx-theme-material

Then, in your conf.py file, change the html_theme variable to:

html_theme = 'material'

And re-build your doc. Enjoy!

Features

  • Dark theme
  • Responsive layout. Mobile friendly
  • Google Analytics support with IP anonymize

Theme variables

  • theme_primary: The primary color for the theme. Default to #6200ee
  • theme_secondary: The secondary color for the theme. Default to #018786
  • analytics_id: The Google Analytics ID

Contribute

This project in under development. If you have ideas or suggestions, please open a issue or send a pull request. Contributions are welcome!