sphinx-better-theme 0.1.5

Compatibility

sphinx-better-theme is compatible with Sphinx 0.6.4+ and Jinja 2.3.1+. Older versions may work but have not been tested.

Method 1: Adding to your source tree

This method is preferred due to the frequency with which sphinx-better-theme is improved.

1. Put the theme in your source tree. If you use git, you can add sphinx-better-theme’s repository as a submodule. Otherwise you can download the zip file and expand it somewhere predictable. Here’s an example using git:

   > git submodule add \
       https://github.com/irskep/sphinx-better-theme.git \
       docs/sphinx-better-theme
   > git submodule update --init

2. Add the parent folder of the theme to your conf.py. If you use the folder structure in the block above, you’d do it like this:

   html_theme_path = ['sphinx-better-theme']

   (because the theme path is sphinx-better-theme/better.)

3. Set html_theme to 'better' in your conf.py.

Method 2: Installing to site-packages

If adding the theme to your source tree is impractical, if you need to share it among several repositories, or if you prefer a more serene frequency of updates, you can install it like a regular Python package.

Download the zip file and run the usual command:

> python setup.py install

Or install from PyPI:

> pip install sphinx-better-theme

To use the theme, set html_theme_path to contain better.better_theme_path, and set html_theme to 'better':

from better import better_theme_path
html_theme_path = [better_theme_path]
html_theme = 'better'