Skip to main content

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!

Metadata

Release files for sphinx-theme-material 1.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-theme-material 1.1.2
File Size Uploaded Provenance Actions
sphinx_theme_material-1.1.2.tar.gz 37.8 kB Without provenance Details for sphinx_theme_material-1.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-theme-material 1.1.2
File Interpreter ABI Platform Actions
sphinx_theme_material-1.1.2-py3-none-any.whl Python 3 none any Details for sphinx_theme_material-1.1.2-py3-none-any.whl

Total release size: 76.7 kB

Release files / sphinx_theme_material-1.1.2.tar.gz

Download URL sphinx_theme_material-1.1.2.tar.gz
Size 37.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b592dbe160722b452fef8176f57e17d650c150a8c32eb9288c449632eb5f5028
BLAKE2b-256 checksum
How to use checksums
b73fe9eb317387904266b9aa87bb64aef522f760fa18d0cb5a36512b5553698d
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / sphinx_theme_material-1.1.2-py3-none-any.whl

Download URL sphinx_theme_material-1.1.2-py3-none-any.whl
Size 38.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea669ebaf9f6db4d6ea5730f442127aec7e259c439e3d87e6565ee16b5262d1b
BLAKE2b-256 checksum
How to use checksums
8683ce2d8c4527d12efecb3cc9f225bcdf90ec9d7011350da291fc46e5eea2a5
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for sphinx-theme-material 1.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page