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: ""
logo_width — Width in ‘px’ or ‘%’. default: ""
logo_height — Height in ‘px’ or ‘%’. default: ""
logo_image_desc — Description after logo image. default: ""
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: ""
github_repo — default: ""
travis_button — Show travis badge under breadcrumbs. default: false
travis_user — default: ""
travis_repo — default: ""
Theme options
You can set theme options in conf.py. Here are list of options with default values:
logo default: False
logo_image default: ""
logo_width default: ""
logo_heigh default: ""
logo_image_desc default: ""
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: ""
github_repo — default: ""
travis_button = default: False
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
File details
Details for the file itcase-sphinx-theme-0.2.0.tar.gz.
File metadata
- Download URL: itcase-sphinx-theme-0.2.0.tar.gz
- Upload date:
- Size: 728.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cad52d8efe536586d7d20fe31144b12e4d9f77ace38bdfe29ddd63a450fa69e1 |
|
| MD5 | 57dc638cf10fe8f938578b1ef228e97b |
|
| BLAKE2b-256 | ffde6da16530baa0cd6ef931048b5f4cceafe9e4137c38a22bae76d46e744eda |
