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.12.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.12.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_orange_book_theme-0.12.0.tar.gz
Algorithm Hash digest
SHA256 ad1233fdbf9f2c24d7d3b2462d60669286a6246e132f5806d8d62e2b1747fc29
MD5 12ec7e67012a697b0f07a3a55ef8b34b
BLAKE2b-256 749ca1d00aba318281a28b650966bac0d9774dae6bbc953e7662d83c2f2142ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb7c584f907e4cbd9f0de8c41882f679ebf59a265ddfa016d37d21f91913863a
MD5 429cf3eba1f9bdffb761e25b08f3cb7d
BLAKE2b-256 748159db621e0380d1505ad6258a85b02099b70adaef29ec18fc658b6126bb9c

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