m-alzam/sphinx_theme_material

Material based python sphinx theme

Material theme

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!

sphinx_theme_material's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

File: renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting String near cies"], }