Skip to main content

Sphinx Theme for Kotti Documentation

Project description

kotti_docs_theme - A Twitter Bootstrap Theme for Sphinx

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

  • Initial release.

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 kotti_docs_theme, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size kotti_docs_theme-0.1.tar.gz (155.5 kB) File type Source Python version None Upload date Hashes View

Supported by

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