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.20.0.tar.gz (4.1 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.20.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_orange_book_theme-0.20.0.tar.gz
Algorithm Hash digest
SHA256 86629e9d8e798af3051342824b35f78a6ccc59d571737b4f512cb2b47d0c27f9
MD5 8c5a98716b98c54174e45f4ae69abed7
BLAKE2b-256 6fe0cb3225141dec5809a9722c6c7e45cfc48b1969e51e95bffbd8c00b0b59b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1975f699b6e4e420f7ea4c070d934104ceff43f407b6a493a2457cd0c28e1f32
MD5 89ac40bd8714f9460d09970e88196de3
BLAKE2b-256 0f091e0b265eab91e938281ab0a2e90be51a833ba9d4b556a1ef4c328dbef920

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