Alice Theme for Sphinx

Provides the Alice theme for Sphinx projects.

Installation

This theme can be installed using pip:

pip install -U sphinx-alice-theme
    (or)
python -m pip install -U sphinx-alice-theme

Usage

For an existing Sphinx documentation set, the Alice theme can be applied by configuring the html_theme value to sphinx_alice_theme. For example:

html_theme = 'sphinx_alice_theme'

The following theme options are available:

html_theme_options = {
    #'canonical_url': 'https://www.example.com',
    #'includehidden': False,
    #'navigation_depth': 4,
    #'prev_next_buttons_location': 'both', # top, bottom, none
    #'titles_only': False,
}

Dependencies

• Gumshoe