← Back to branch summary

~ubuntuone-pqm-team/requests/stable

« back to all changes in this revision

Viewing changes to docs/_themes/README.rst

  • Committer: Ricardo Kirkner
  • Date: 2014-02-12 20:15:17 UTC
  • Revision ID: ricardo.kirkner@canonical.com-20140212201517-h11q42rfwrnyk17k
Tags: 2.2.1
imported requests 2.2.1 from tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/_themes/README.rst
1
 
krTheme Sphinx Style
2
 
====================
3
 
 
4
 
This repository contains sphinx styles Kenneth Reitz uses in most of
5
 
his projects. It is a derivative of Mitsuhiko's themes for Flask and Flask related
6
 
projects.  To use this style in your Sphinx documentation, follow
7
 
this guide:
8
 
 
9
 
1. put this folder as _themes into your docs folder.  Alternatively
10
 
   you can also use git submodules to check out the contents there.
11
 
 
12
 
2. add this to your conf.py: ::
13
 
 
14
 
    sys.path.append(os.path.abspath('_themes'))
15
 
    html_theme_path = ['_themes']
16
 
    html_theme = 'flask'
17
 
 
18
 
The following themes exist:
19
 
 
20
 
**kr**
21
 
    the standard flask documentation theme for large projects
22
 
 
23
 
**kr_small**
24
 
    small one-page theme.  Intended to be used by very small addon libraries.
25