Skip to main content

Provides the Alice theme for Sphinx projects.

Project description

Alice Theme for Sphinx

pip Version Build Documentation

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-alice-theme-0.2.0.tar.gz (13.8 kB view hashes)

Uploaded source

Built Distribution

sphinx_alice_theme-0.2.0-py3-none-any.whl (15.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page