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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_orange_book_theme-0.18.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.18.0.tar.gz
Algorithm Hash digest
SHA256 a52bab3c1e17e61214a4c2400a6e61685040be7189b5e4e93e96e1a8c62a15c5
MD5 07b7b355fc2cc42e00fbc38b9b97adaa
BLAKE2b-256 27f2531cc1fa9d2a88789a2bb80656dddede54eb2d2a164500fb3299cbb1178c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76951edcc61a483a4a6a8729f8fce071d06a8ad7501ca4988bf50f20f39fec26
MD5 1bc450460316b3297d01f657b6a6735b
BLAKE2b-256 7b098f789d0380672eb8202cea20641ca9a7ad7c5e6ffad0b865ae30fecab566

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