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

ScreenShots

ustu/lectures.www

https://cdn.rawgit.com/ITCase/itcase_sphinx_theme/master/example/_static/screen1.png

ITCase/sqlalchemy_mptt

https://cdn.rawgit.com/ITCase/itcase_sphinx_theme/master/example/_static/screen2.png

Ergo/ziggurat_foundations

https://cdn.rawgit.com/ITCase/itcase_sphinx_theme/master/example/_static/screen3.png

And other…

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

itcase-sphinx-theme-0.3.1.tar.gz (2.6 MB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page