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.13.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.13.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_orange_book_theme-0.13.0.tar.gz
Algorithm Hash digest
SHA256 0ccdc9822c46c714c616730ade54b66d610e463fbfcf175365fdb2a9f05a8aa6
MD5 3d30211e7aca3e03d21b91f6efefa0bc
BLAKE2b-256 2527001302aaaf8a6afd0fc49e687f315503eca2e828b0226b90400cc39dfb00

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0e6f07a76dd98ea410786dbe78a80cf6a5cb1760b0592f72ea3b200d4aa83f5
MD5 0f86776d30ed2b13aca8cf786e85d7ba
BLAKE2b-256 e8b1fa1092c7dbe9bb6fb421b03e3a9be8712195f6253fea95802d9754c3a678

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