Sphinx Theme for Kotti Documentation
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
kotti_docs_theme-0.2.tar.gz
(155.8 kB
view hashes)