A material based sphinx theme

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for m_alzam from gravatar.com m_alzam

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPLv3+)
  • Author: Manuel Alcaraz Zambrano
  • Tags sphinx, theme
Classifiers

Project description

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!

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for m_alzam from gravatar.com m_alzam

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (GPLv3+)
  • Author: Manuel Alcaraz Zambrano
  • Tags sphinx, theme
Classifiers

Release history Release notifications | RSS feed

This version

1.1.2

1.1.1

1.1.0

1.0.0

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.2.tar.gz (37.8 kB view details)

Uploaded Source

Built Distribution

sphinx_theme_material-1.1.2-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_theme_material-1.1.2.tar.gz.

File metadata

  • Download URL: sphinx_theme_material-1.1.2.tar.gz
  • Upload date:
  • Size: 37.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

File hashes

Hashes for sphinx_theme_material-1.1.2.tar.gz
Algorithm Hash digest
SHA256 b592dbe160722b452fef8176f57e17d650c150a8c32eb9288c449632eb5f5028
MD5 362d62d58f3cc8ffb89ae3d5a9245e69
BLAKE2b-256 b73fe9eb317387904266b9aa87bb64aef522f760fa18d0cb5a36512b5553698d

See more details on using hashes here.

File details

Details for the file sphinx_theme_material-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: sphinx_theme_material-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

File hashes

Hashes for sphinx_theme_material-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea669ebaf9f6db4d6ea5730f442127aec7e259c439e3d87e6565ee16b5262d1b
MD5 7da9810cb9b31b1a45659596ebc99178
BLAKE2b-256 8683ce2d8c4527d12efecb3cc9f225bcdf90ec9d7011350da291fc46e5eea2a5

See more details on using hashes here.

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