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.17.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.17.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_orange_book_theme-0.17.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.17.0.tar.gz
Algorithm Hash digest
SHA256 ec69554652a32d766307bca131ec03d5694dbf19b1eef47d5cda474541d04fd5
MD5 66a5127bdf5a08c92be648df1cfef12f
BLAKE2b-256 b83167fdbff027c915757439de5f39bc7f1b7375c1d1a60947549146576b72d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e1b9967656a1ee72237617a81581ed6313393410a9820f36a7464043b1c9484
MD5 a3164926247f0e662568663132e57c22
BLAKE2b-256 6cd26943f20a46ce9d8e888d1b6ec0b5b0eeabd0153e4a9d6ce6bd594dd60b6d

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