1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
|
Metadata-Version: 1.1
Name: guzzle_sphinx_theme
Version: 0.7.11
Summary: Sphinx theme used by Guzzle.
Home-page: https://github.com/guzzle/guzzle_sphinx_theme
Author: Michael Dowling
Author-email: mtdowling@gmail.com
License: UNKNOWN
Description: ===================
Guzzle Sphinx Theme
===================
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:
.. code-block:: python
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:
.. code-block:: python
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.
.. code-block:: bash
mkdir source/_templates
touch source/_templates/layout.html
Then, configure your "conf.py":
.. code-block:: python
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.
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
|