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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_orange_book_theme-0.16.0.tar.gz
Algorithm Hash digest
SHA256 061216dec32b7830c00055c44e5fbdd765df293f059c2afc01e02a8a31168339
MD5 d6c2e16296166d3b791027b3a5692cb5
BLAKE2b-256 6b348f3e93a477868259d0d0a56526618edebfb719cff7ecdbb0a6accd4390bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_orange_book_theme-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 106a60c1bcf140e801bb3a2be3189a06c2875e6666659eda2592561e481e1483
MD5 b3f380103e7d5d38bc443f1ee3f9bd57
BLAKE2b-256 d1ebebe6283c4d195fd0a68fdff36b1e8a1f79661a69de4e97a40137cf4d6e0c

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