Sphinx theme used by Guzzle.
Project description
Sphinx theme used by Guzzle: http://guzzlephp.org
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 # 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' # Register the theme as an extension to generate a sitemap.xml extensions.append("guzzle_sphinx_theme") # Guzzle theme options (see theme.conf for more information) html_theme_options = { # Set the name of the project to appear in the sidebar "project_nav_name": "Project Name", }
There are a lot more ways to customize this theme, as this more comprehensive example shows:
import guzzle_sphinx_theme # 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' # Register the theme as an extension to generate a sitemap.xml extensions.append("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 left sidebar. "project_nav_name": "Project Name", # 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", # Path to a touch icon "touch_icon": "", # Specify a base_url used to generate sitemap.xml links. If not # specified, then no sitemap will be built. "base_url": "" # Allow a separate homepage from the master_doc "homepage": "index", # Allow the project link to be overriden to a custom URL. "projectlink": "http://myproject.url", }
Customizing the layout
You can customize the theme by overriding Jinja template blocks. For example, “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" %} {%- block extra_head %} {# Add custom things to the head HTML tag #} {# Call the parent block #} {{ super() }} {%- endblock %}
Note
If you are using Readthedocs, then you might run into an issue where they don’t currently allow you to extend layout.html.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for guzzle_sphinx_theme-0.7.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b8c1639c343c02c3f3db7df660ddf6f533b5454ee92a5f7b02edaa573fed3e6 |
|
MD5 | f6ec1c3fe16ce9f076941912df0cc4cd |
|
BLAKE2-256 | f47daed8cd5e4ca52bb8550d2c33fcbb8d6dbd5c2cf5e1694202d2135b374eba |