Skip to content

miaowware/miaowware-sphinx-theme

Miaowware Sphinx Theme

This theme is used for sphinx documentation of Miaowware projects.

Usage

Install with pip install -e git+https://github.com/miaowware/miaowware-sphinx-theme.git#egg=miaowware_sphinx_theme , or add -e git+https://github.com/miaowware/miaowware-sphinx-theme.git#egg=miaowware_sphinx_theme to your sphinx requirements.txt.

In your sphinx conf.py, add:

import miaowware_sphinx_theme

# ...

html_theme = "miaowware"
html_theme_path = miaowware_sphinx_theme.get_html_theme_path()

# If you want a logo
html_logo = "_static/your_logo.png"

Copyright

Copyright 2020 classabbyamp, 0x5c
Released under the BSD 3-Clause License.
See LICENSE for the full license text.

Screenshots

Theme Screenshot