itcase-sphinx-theme 0.2.0

ITCase Sphinx themes for documentation styling.

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: ""

1. 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