Skip to main content

ITCase Sphinx themes for documentation styling.

Project description

PyPI

ITCase Sphinx Theme

Install

$ pip install itcase_sphinx_theme -U

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()]

If you want see version of theme in the bottom just add extension:

extensions = ['itcase_sphinx_theme']

Theme options

You can set theme options in conf.py like.

html_theme_options = {
    'travis_button': True,
    '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_userdefault: ""
  • github_repodefault: ""
  • travis_button — Show travis badge under breadcrumbs. default: false
  • travis_userdefault: ""
  • travis_repodefault: ""
  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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for itcase-sphinx-theme, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size itcase-sphinx-theme-0.3.1.tar.gz (2.6 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page