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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_orange_book_theme-0.21.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.21.0.tar.gz
Algorithm Hash digest
SHA256 6b2cc1115488aaf03cc038fc731ba9628f44e35ffc1ff10404c70174cdff88cb
MD5 45f0d125fee2ba0224d9d09decdc0cbb
BLAKE2b-256 c8cf3136a5877791ba1e49f65f47091edcad5f7177ea25b85719e7e30aafb54e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57c09276081c0a99f6db1f0b119b7665af90d932339a33897a5719580e0b473f
MD5 47d9e14e88b8bf81f2d0bd2e2aa1643a
BLAKE2b-256 7b85d2d0abba8f6c4d45928d67649ddb5f947e23db25095bb51039a66eeaf8c7

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