~tcuthbert/wordpress/openstack-objectstorage

« back to all changes in this revision

Viewing changes to vendor/guzzlehttp/guzzle/docs/conf.py

  • Committer: Jacek Nykis
  • Date: 2015-02-11 15:35:31 UTC
  • Revision ID: jacek.nykis@canonical.com-20150211153531-hmy6zi0ov2qfkl0b
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
import sys, os
 
2
from sphinx.highlighting import lexers
 
3
from pygments.lexers.web import PhpLexer
 
4
 
 
5
lexers['php'] = PhpLexer(startinline=True, linenos=1)
 
6
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
 
7
primary_domain = 'php'
 
8
 
 
9
# -- General configuration -----------------------------------------------------
 
10
 
 
11
extensions = []
 
12
templates_path = ['_templates']
 
13
source_suffix = '.rst'
 
14
master_doc = 'index'
 
15
 
 
16
project = u'Guzzle'
 
17
copyright = u'2012, Michael Dowling'
 
18
version = '3.0.0'
 
19
release = '3.0.0'
 
20
 
 
21
exclude_patterns = ['_build']
 
22
 
 
23
# -- Options for HTML output ---------------------------------------------------
 
24
 
 
25
# The name for this set of Sphinx documents.  If None, it defaults to
 
26
# "<project> v<release> documentation".
 
27
html_title = "Guzzle documentation"
 
28
html_short_title = "Guzzle"
 
29
 
 
30
# Add any paths that contain custom static files (such as style sheets) here,
 
31
# relative to this directory. They are copied after the builtin static files,
 
32
# so a file named "default.css" will overwrite the builtin "default.css".
 
33
html_static_path = ['_static']
 
34
 
 
35
# Custom sidebar templates, maps document names to template names.
 
36
html_sidebars = {
 
37
    '**':       ['localtoc.html', 'searchbox.html']
 
38
}
 
39
 
 
40
# Output file base name for HTML help builder.
 
41
htmlhelp_basename = 'Guzzledoc'
 
42
 
 
43
# -- Guzzle Sphinx theme setup ------------------------------------------------
 
44
 
 
45
sys.path.insert(0, '/Users/dowling/projects/guzzle_sphinx_theme')
 
46
 
 
47
import guzzle_sphinx_theme
 
48
html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
 
49
html_theme_path = guzzle_sphinx_theme.html_theme_path()
 
50
html_theme = 'guzzle_sphinx_theme'
 
51
 
 
52
# Guzzle theme options (see theme.conf for more information)
 
53
html_theme_options = {
 
54
    "project_nav_name": "Guzzle",
 
55
    "github_user": "guzzle",
 
56
    "github_repo": "guzzle",
 
57
    "disqus_comments_shortname": "guzzle",
 
58
    "google_analytics_account": "UA-22752917-1"
 
59
}
 
60
 
 
61
# -- Options for LaTeX output --------------------------------------------------
 
62
 
 
63
latex_elements = {}
 
64
 
 
65
# Grouping the document tree into LaTeX files. List of tuples
 
66
# (source start file, target name, title, author, documentclass [howto/manual]).
 
67
latex_documents = [
 
68
  ('index', 'Guzzle.tex', u'Guzzle Documentation',
 
69
   u'Michael Dowling', 'manual'),
 
70
]
 
71
 
 
72
# -- Options for manual page output --------------------------------------------
 
73
 
 
74
# One entry per manual page. List of tuples
 
75
# (source start file, name, description, authors, manual section).
 
76
man_pages = [
 
77
    ('index', 'guzzle', u'Guzzle Documentation',
 
78
     [u'Michael Dowling'], 1)
 
79
]
 
80
 
 
81
# If true, show URL addresses after external links.
 
82
#man_show_urls = False
 
83
 
 
84
# -- Options for Texinfo output ------------------------------------------------
 
85
 
 
86
# Grouping the document tree into Texinfo files. List of tuples
 
87
# (source start file, target name, title, author,
 
88
#  dir menu entry, description, category)
 
89
texinfo_documents = [
 
90
  ('index', 'Guzzle', u'Guzzle Documentation',
 
91
   u'Michael Dowling', 'Guzzle', 'One line description of project.',
 
92
   'Miscellaneous'),
 
93
]