Skip to main content

An orange version of sphinx-book-theme.

Project description

sphinx-orange-book-theme

PyPI - Python Version PyPI - Version PyPI - License Gitlab pipeline status pre-commit

An orange version of sphinx-book-theme.

This python package overrides CSS of sphinx-book-theme to change its design.

For an example of built document, see Documentation built on main branch.

Usage

To use this theme,

  1. Install sphinx-orange-book-theme package from PyPI, for example, using the following command:

    pip install sphinx-orange-book-theme
    
  2. Update your conf.py file to use sphinx_orange_book_theme theme as following:

    html_theme = "sphinx_orange_book_theme"
    
  3. (Recommended) Add following options to conf.py:

    html_theme_options = {
        "pygment_light_style": "gruvbox-light",
        "pygment_dark_style": "native",
    }
    

    Although these options are not required to use this theme, this theme is designed with the above options.

Documentation

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_orange_book_theme-0.8.0.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

sphinx_orange_book_theme-0.8.0-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page