diff options
Diffstat (limited to 'docs/_themes/README')
| -rw-r--r-- | docs/_themes/README | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/_themes/README b/docs/_themes/README new file mode 100644 index 000000000..d5a27a7c7 --- /dev/null +++ b/docs/_themes/README @@ -0,0 +1,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 |