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 = {
        "pygments_light_style": "gruvbox-light",
        "pygments_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.19.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_orange_book_theme-0.19.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_orange_book_theme-0.19.0.tar.gz.

File metadata

  • Download URL: sphinx_orange_book_theme-0.19.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/5.15.154+

File hashes

Hashes for sphinx_orange_book_theme-0.19.0.tar.gz
Algorithm Hash digest
SHA256 a7bdbc6b043f229fd8ceb368428a75fec3a626f0874eeb6b3f280d075ff85f63
MD5 7b1a2d6dccad52ddb4a936d7efee61bc
BLAKE2b-256 c639bbaba99222380a654a9950332db4ed624190cdf34e23cc1c857af5d67faa

See more details on using hashes here.

File details

Details for the file sphinx_orange_book_theme-0.19.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc0daba77ce55096ff0c1fcafd91d055f3cf2e6662df8fb80f316c8fbcae3f17
MD5 f062f75e211ff710dfaaae265c98206a
BLAKE2b-256 7a932dd75e5dd0e2d68c999963895bda0ba5148a844a41c86f9a7e391558c486

See more details on using hashes here.

Supported by

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