Metadata-Version: 2.1
Name: sphinx-theme-material
Version: 1.1.2
Summary: A material based sphinx theme
Home-page: https://github.com/m-alzam/sphinx_theme_material
Author: Manuel Alcaraz Zambrano
License: GPLv3+
Keywords: sphinx theme
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/markdown

Material theme
==============

[![CI status](https://github.com/m-alzam/sphinx_theme_material/workflows/CI/badge.svg)](https://github.com/m-alzam/sphinx_theme_material/actions?query=workflow%3ACI)
[![PyPI](https://img.shields.io/pypi/v/sphinx-theme-material)](https://pypi.org/project/sphinx-theme-material/)
![PyPI - Status](https://img.shields.io/pypi/status/sphinx-theme-material)

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!


