summaryrefslogtreecommitdiff
path: root/docs/_themes/README
blob: d5a27a7c7ce12f749980d572d83d41143ca9d564 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Pylons Sphinx Theme
===================

This repository contains Pylons themes for Pylons related projects.
To use a theme 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 = 'pylons'

The following themes exist:

- 'pylons' - the standard Pylons documentation theme for large
  projects