openwisp-sphinx-theme

A Sphinx theme for OpenWISP docs, based on the Read The Docs default theme (sphinx_rtd_theme).

Live demo: https://openwisp-sphinx-theme.readthedocs.io/en/latest/

Installation

This theme is distributed on PyPI as openwisp-sphinx-theme and can be installed with pip:

$ python3 -m pip install openwisp-sphinx-theme

To use the theme in your Sphinx project, you will need to add the following to your conf.py file:

# add this extension
extensions = [...,
'openwisp.sphinx.theme',
...
]
html_theme = "openwisp-sphinx-theme"

Development

python3 -m pip install -e .
make clean # Not always needed, but better to be cautious
make html
open build/html/index.html

Need help?

• If any help regarding installing and using sphinx and reStructured Text is required then please visit this link.
• Feel free to post any doubt or comment through our support channels.