https://github.com/alcarazzam/sphinx_theme_material

Material based python sphinx theme
https://github.com/alcarazzam/sphinx_theme_material

material-design python sphinx sphinx-doc sphinx-theme

Last synced: 2 months ago
JSON representation

Material based python sphinx theme

• Host: GitHub
• URL: https://github.com/alcarazzam/sphinx_theme_material
• Owner: alcarazzam
• License: other
• Created: 2019-07-08T17:15:25.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T21:47:38.000Z (about 2 years ago)
• Last Synced: 2024-12-09T05:29:17.260Z (2 months ago)
• Topics: material-design, python, sphinx, sphinx-doc, sphinx-theme
• Language: HTML
• Homepage: https://m-alzam.github.io/sphinx_theme_material/
• Size: 1.32 MB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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!