skip to navigation
skip to content

Not Logged In

kotti_docs_theme 0.2

Sphinx Theme for Kotti Documentation

This theme is based on sphinx-bootstrap by Scotch Media and modified for documentation of Kotti and Kotti add-ons.

How does it look?

Visit the Kotti Documentation to see the theme in action.

How to use

Install from PyPI:

pip install kotti_docs_theme

Adjust the settings in your Sphinx conf.py file:

import kotti_docs_theme

html_theme_path = [kotti_docs_theme.get_theme_dir()]
html_theme = 'kotti_docs_theme'
html_theme_options = {
    'github_user': 'Pylons',
    'github_repo': 'Kotti',
    'twitter_username': 'KottiCMS',
    'home_url': 'http://kotti.pylonsproject.org/',
    'mailing_list_url': 'http://groups.google.com/group/kotti',
    'irc_channel_url': 'irc://irc.freenode.net/#kotti',
}

Add a rtd.txt file containing the requirements for building the docs on Read The Docs:

Sphinx
kotti_docs_theme
repoze.sphinx.autointerface
repoze.lru

Change History

0.2

  • Make all html_theme_options keys optional to make the theme usable for docs outside the Kotti universe.

0.1.1

  • Make definitions of classes, functions, methods and attributes larger.

0.1

  • Initial release.
 
File Type Py Version Uploaded on Size
kotti_docs_theme-0.2.tar.gz (md5) Source 2013-05-11 152KB
  • Downloads (All Versions):
  • 3 downloads in the last day
  • 40 downloads in the last week
  • 274 downloads in the last month