debian-tablib/docs/_themes
Kenneth Reitz 7c963a0f4d SOPA 2012-01-18 11:24:18 -05:00
..
kr SOPA 2012-01-18 11:24:18 -05:00
kr_small Added kr theme. 2010-10-05 17:29:32 -04:00
.gitignore Added kr theme. 2010-10-05 17:29:32 -04:00
LICENSE New Year! 2011-01-10 19:28:12 -05:00
README.rst Added kr theme. 2010-10-05 17:29:32 -04:00
flask_theme_support.py Added kr theme. 2010-10-05 17:29:32 -04:00

README.rst

krTheme Sphinx Style
====================

This repository contains sphinx styles Kenneth Reitz uses in most of 
his projects. It is a drivative of Mitsuhiko's themes for Flask and Flask related
projects.  To use this style in your Sphinx documentation, follow
this guide:

1. put this folder as _themes into your docs folder.  Alternatively
   you can also use git submodules to check out the contents there.

2. add this to your conf.py: ::

	sys.path.append(os.path.abspath('_themes'))
	html_theme_path = ['_themes']
	html_theme = 'flask'

The following themes exist:

**kr**
	the standard flask documentation theme for large projects

**kr_small**
	small one-page theme.  Intended to be used by very small addon libraries.