Skip to main content

A material based sphinx theme

Project description

Material theme

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_theme_material-1.1.0.tar.gz (41.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_theme_material-1.1.0-py3-none-any.whl (42.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page