guzzle_sphinx_theme 0.2.1

Installation

Install via pip:

$ pip install guzzle_sphinx_theme

or if you have the code checked out locally:

$ python setup.py install

Configuration

Add the following to your conf.py:

import guzzle_sphinx_theme
# Uses a Guzzle style Pygments theme
pygments_style = 'guzzle_sphinx_theme.GuzzleStyle'
# Adds an HTML table visitor to apply Bootstrap table classes
html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = 'guzzle_sphinx_theme'

# Guzzle theme options (see theme.conf for more information)
html_theme_options = {

    # Set the path to a special layout to include for the homepage
    "index_template": "special_index.html",

    # Set the name of the project to appear in the nav menu
    "project_nav_name": "Project Name",

    # Set your GitHub user and repo to enable GitHub stars links
    "github_user": "my_github_user",
    "github_repo": "my_github_repo",

    # Set your Disqus short name to enable comments
    "disqus_comments_shortname": "my_disqus_comments_short_name",

    # Set you GA account ID to enable tracking
    "google_analytics_account": "my_ga_account",

    # Set a custom class to add to the navbar (e.g. navbar-inverse)
    "navbar_class": "",

    # Path to a touch icon
    "touch_icon": "",

    # Set to true to bind left and right key events to turn the page
    "bind_key_events": 1
}

Customizing the layout

You need to customize the navigation links of “layout.html” using a theme customization. “layout.html” contains several blocks that can be overridden or extended.

Place a “layout.html” file in your project’s “/_templates” directory.

mkdir source/_templates
touch source/_templates/layout.html

Then, configure your “conf.py”:

templates_path = ['_templates']

Finally, edit your override file “source/_templates/layout.html”:

{# Import the theme’s layout. #} {% extends “!layout.html” %}

{# Customize the links in the main nav menu #} {%- block nav_links %} <li><a href=”{{ pathto(master_doc) }}”>Home</a></li> <li><a href=”{{ pathto(‘docs’) }}”>Docs</a></li> <!– etc… –> {%- endblock %}