ITCase Sphinx themes for documentation styling.
Project description
ITCase Sphinx Theme
Install
$ pip install itcase_sphinx_theme
Edit your Sphinx’s conf.py
Near the top, add the following
import itcase_sphinx_theme
Activate the theme
html_theme = 'itcase' html_theme_path = [itcase_sphinx_theme.get_html_themes_path()] extensions = ['itcase_sphinx_theme']
Theme options
You can set theme options in conf.py like.
html_theme_options = { 'github_button': True 'github_user': 'ITCase', 'github_repo': 'pyramid_sacrud', }
Here are list of options with default values:
logo — Show logo at the top of navigation menu. default: false
logo_image — Path to logo. default: null
logo_width — Width in ‘px’ or ‘%’. default: null
logo_height — Height in ‘px’ or ‘%’. default: null
logo_image_desc — Description after logo image. default: null
index_menu — Show navigation menu on main page. default: false
sticky_menu — Make navigation element always visible on page. default: true
github_button — Show git star badge under breadcrumbs. default: false
github_user — default: null
github_repo — default: null
travis_button — Show travis badge under breadcrumbs. default: false
travis_user — default: null
travis_repo — default: null
Theme options
You can set theme options in conf.py. Here are list of options with default values:
logo default: False
logo_image default: null
logo_width default: null
logo_heigh default: null
logo_image_desc default: null
aindex_menu default: False
sticky_menu — default: True
Make navigation element always visible on page.
github_button — default: False
Show git star repository button under breadcrumbs.
github_user — default: null
github_repo — default: null
travis_button = default: False
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for itcase-sphinx-theme-0.1.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d16c1bb398efcf2d1ee36c465719373b3552e10a2b78b17d9a2351c3ead416f7 |
|
MD5 | ccd0a55cb6cd06aa2e3fefbd30dfcbd4 |
|
BLAKE2b-256 | d0a25eafcec5eca07a9f126ffa388df3914dcec53cf2f24d6834210749e12158 |