Sphinx Material Design Theme

Introduction

sphinx_md_theme is a MDL-based theme originally based on Dave Snider’s Sphinx theme for Read the Docs (sphinx_rtd_theme). This theme has been tested on Sphinx 1.3+.

Installation

$ pip install sphinx_md_theme

Once installed, change html_theme in your conf.py to material_design.

Configuration

  • pygments_theme: The name of a Pygments style.
  • ribbon_bg: Optional path to an image to display in the ribbon background.
  • ribbon_bg_position: Defaults to auto auto.
  • ribbon_bg_size: Defaults to 100% auto.