@@ -21,119 +21,121 @@ def __init__(self, *args):
21
21
def __getattr__ (self , name ):
22
22
return Mock
23
23
24
- MOCK_MODULES = ['zookeeper' ]
24
+
25
+ MOCK_MODULES = ["zookeeper" ]
25
26
for mod_name in MOCK_MODULES :
26
27
sys .modules [mod_name ] = Mock ()
27
28
28
29
# If extensions (or modules to document with autodoc) are in another directory,
29
30
# add these directories to sys.path here. If the directory is relative to the
30
31
# documentation root, use os.path.abspath to make it absolute, like shown here.
31
- sys .path .insert (0 , os .path .abspath ('..' ))
32
+ sys .path .insert (0 , os .path .abspath (".." ))
32
33
33
34
# -- General configuration -----------------------------------------------------
34
35
35
36
# If your documentation needs a minimal Sphinx version, state it here.
36
- #needs_sphinx = '1.0'
37
+ # needs_sphinx = '1.0'
37
38
38
39
# Add any Sphinx extension module names here, as strings. They can be extensions
39
40
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
40
41
extensions = [
41
- ' sphinx.ext.autodoc' ,
42
- ' sphinx.ext.doctest' ,
43
- ' sphinx.ext.viewcode' ,
42
+ " sphinx.ext.autodoc" ,
43
+ " sphinx.ext.doctest" ,
44
+ " sphinx.ext.viewcode" ,
44
45
]
45
46
46
47
# Add any paths that contain templates here, relative to this directory.
47
- templates_path = [' _templates' ]
48
+ templates_path = [" _templates" ]
48
49
49
50
# The suffix of source filenames.
50
- source_suffix = ' .rst'
51
+ source_suffix = " .rst"
51
52
52
53
# The encoding of source files.
53
- #source_encoding = 'utf-8-sig'
54
+ # source_encoding = 'utf-8-sig'
54
55
55
56
# The master toctree document.
56
- master_doc = ' index'
57
+ master_doc = " index"
57
58
58
59
# General information about the project.
59
- project = u' kazoo'
60
- copyright = u' 2011-2014, Kazoo team'
60
+ project = " kazoo"
61
+ copyright = " 2011-2014, Kazoo team"
61
62
62
63
# The version info for the project you're documenting, acts as replacement for
63
64
# |version| and |release|, also used in various other places throughout the
64
65
# built documents.
65
66
#
66
67
# The full version, including alpha/beta/rc tags.
67
68
from kazoo import version
69
+
68
70
release = version .__version__
69
71
70
72
# The short X.Y version.
71
- version = '.' .join (release .split ('.' )[:- 1 ])
73
+ version = "." .join (release .split ("." )[:- 1 ])
72
74
73
75
# The language for content autogenerated by Sphinx. Refer to documentation
74
76
# for a list of supported languages.
75
- #language = None
77
+ # language = None
76
78
77
79
# There are two options for replacing |today|: either, you set today to some
78
80
# non-false value, then it is used:
79
- #today = ''
81
+ # today = ''
80
82
# Else, today_fmt is used as the format for a strftime call.
81
- #today_fmt = '%B %d, %Y'
83
+ # today_fmt = '%B %d, %Y'
82
84
83
85
# List of patterns, relative to source directory, that match files and
84
86
# directories to ignore when looking for source files.
85
- exclude_patterns = [' _build' ]
87
+ exclude_patterns = [" _build" ]
86
88
87
89
# The reST default role (used for this markup: `text`) to use for all documents.
88
- #default_role = None
90
+ # default_role = None
89
91
90
92
# If true, '()' will be appended to :func: etc. cross-reference text.
91
- #add_function_parentheses = True
93
+ # add_function_parentheses = True
92
94
93
95
# If true, the current module name will be prepended to all description
94
96
# unit titles (such as .. function::).
95
- #add_module_names = True
97
+ # add_module_names = True
96
98
97
99
# If true, sectionauthor and moduleauthor directives will be shown in the
98
100
# output. They are ignored by default.
99
- #show_authors = False
101
+ # show_authors = False
100
102
101
103
# The name of the Pygments (syntax highlighting) style to use.
102
- pygments_style = ' sphinx'
104
+ pygments_style = " sphinx"
103
105
104
106
# A list of ignored prefixes for module index sorting.
105
- #modindex_common_prefix = []
107
+ # modindex_common_prefix = []
106
108
107
109
108
110
# -- Options for HTML output ---------------------------------------------------
109
111
110
112
# The theme to use for HTML and HTML Help pages. See the documentation for
111
113
# a list of builtin themes.
112
- html_theme = ' default'
114
+ html_theme = " default"
113
115
114
116
# Theme options are theme-specific and customize the look and feel of a theme
115
117
# further. For a list of options available for each theme, see the
116
118
# documentation.
117
- #html_theme_options = {}
119
+ # html_theme_options = {}
118
120
119
121
# Add any paths that contain custom themes here, relative to this directory.
120
- #html_theme_path = []
122
+ # html_theme_path = []
121
123
122
124
# The name for this set of Sphinx documents. If None, it defaults to
123
125
# "<project> v<release> documentation".
124
- #html_title = None
126
+ # html_title = None
125
127
126
128
# A shorter title for the navigation bar. Default is the same as html_title.
127
- #html_short_title = None
129
+ # html_short_title = None
128
130
129
131
# The name of an image file (relative to this directory) to place at the top
130
132
# of the sidebar.
131
- #html_logo = None
133
+ # html_logo = None
132
134
133
135
# The name of an image file (within the static path) to use as favicon of the
134
136
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135
137
# pixels large.
136
- #html_favicon = None
138
+ # html_favicon = None
137
139
138
140
# Add any paths that contain custom static files (such as style sheets) here,
139
141
# relative to this directory. They are copied after the builtin static files,
@@ -142,101 +144,95 @@ def __getattr__(self, name):
142
144
143
145
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
144
146
# using the given strftime format.
145
- #html_last_updated_fmt = '%b %d, %Y'
147
+ # html_last_updated_fmt = '%b %d, %Y'
146
148
147
149
# If true, SmartyPants will be used to convert quotes and dashes to
148
150
# typographically correct entities.
149
- #html_use_smartypants = True
151
+ # html_use_smartypants = True
150
152
151
153
# Custom sidebar templates, maps document names to template names.
152
- #html_sidebars = {}
154
+ # html_sidebars = {}
153
155
154
156
# Additional templates that should be rendered to pages, maps page names to
155
157
# template names.
156
- #html_additional_pages = {}
158
+ # html_additional_pages = {}
157
159
158
160
# If false, no module index is generated.
159
- #html_domain_indices = True
161
+ # html_domain_indices = True
160
162
161
163
# If false, no index is generated.
162
- #html_use_index = True
164
+ # html_use_index = True
163
165
164
166
# If true, the index is split into individual pages for each letter.
165
- #html_split_index = False
167
+ # html_split_index = False
166
168
167
169
# If true, links to the reST sources are added to the pages.
168
- #html_show_sourcelink = True
170
+ # html_show_sourcelink = True
169
171
170
172
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171
- #html_show_sphinx = True
173
+ # html_show_sphinx = True
172
174
173
175
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174
- #html_show_copyright = True
176
+ # html_show_copyright = True
175
177
176
178
# If true, an OpenSearch description file will be output, and all pages will
177
179
# contain a <link> tag referring to it. The value of this option must be the
178
180
# base URL from which the finished HTML is served.
179
- #html_use_opensearch = ''
181
+ # html_use_opensearch = ''
180
182
181
183
# This is the file name suffix for HTML files (e.g. ".xhtml").
182
- #html_file_suffix = None
184
+ # html_file_suffix = None
183
185
184
186
# Output file base name for HTML help builder.
185
- htmlhelp_basename = ' kazoodoc'
187
+ htmlhelp_basename = " kazoodoc"
186
188
187
189
188
190
# -- Options for LaTeX output --------------------------------------------------
189
191
190
192
latex_elements = {
191
- # The paper size ('letterpaper' or 'a4paper').
192
- #'papersize': 'letterpaper',
193
-
194
- # The font size ('10pt', '11pt' or '12pt').
195
- #'pointsize': '10pt',
196
-
197
- # Additional stuff for the LaTeX preamble.
198
- #'preamble': '',
193
+ # The paper size ('letterpaper' or 'a4paper').
194
+ #'papersize': 'letterpaper',
195
+ # The font size ('10pt', '11pt' or '12pt').
196
+ #'pointsize': '10pt',
197
+ # Additional stuff for the LaTeX preamble.
198
+ #'preamble': '',
199
199
}
200
200
201
201
# Grouping the document tree into LaTeX files. List of tuples
202
202
# (source start file, target name, title, author, documentclass [howto/manual]).
203
203
latex_documents = [
204
- ('index' , 'kazoo.tex' , u'kazoo Documentation' ,
205
- u'Various Authors' , 'manual' ),
204
+ ("index" , "kazoo.tex" , "kazoo Documentation" , "Various Authors" , "manual" ),
206
205
]
207
206
208
207
# The name of an image file (relative to this directory) to place at the top of
209
208
# the title page.
210
- #latex_logo = None
209
+ # latex_logo = None
211
210
212
211
# For "manual" documents, if this is true, then toplevel headings are parts,
213
212
# not chapters.
214
- #latex_use_parts = False
213
+ # latex_use_parts = False
215
214
216
215
# If true, show page references after internal links.
217
- #latex_show_pagerefs = False
216
+ # latex_show_pagerefs = False
218
217
219
218
# If true, show URL addresses after external links.
220
- #latex_show_urls = False
219
+ # latex_show_urls = False
221
220
222
221
# Documents to append as an appendix to all manuals.
223
- #latex_appendices = []
222
+ # latex_appendices = []
224
223
225
224
# If false, no module index is generated.
226
- #latex_domain_indices = True
225
+ # latex_domain_indices = True
227
226
228
227
229
228
# -- Options for manual page output --------------------------------------------
230
229
231
230
# One entry per manual page. List of tuples
232
231
# (source start file, name, description, authors, manual section).
233
- man_pages = [
234
- ('index' , 'kazoo' , u'kazoo Documentation' ,
235
- [u'Various Authors' ], 1 )
236
- ]
232
+ man_pages = [("index" , "kazoo" , "kazoo Documentation" , ["Various Authors" ], 1 )]
237
233
238
234
# If true, show URL addresses after external links.
239
- #man_show_urls = False
235
+ # man_show_urls = False
240
236
241
237
242
238
# -- Options for Texinfo output ------------------------------------------------
@@ -245,15 +241,22 @@ def __getattr__(self, name):
245
241
# (source start file, target name, title, author,
246
242
# dir menu entry, description, category)
247
243
texinfo_documents = [
248
- ('index' , 'kazoo' , u'kazoo Documentation' , u'Various Authors' ,
249
- 'kazoo' , 'One line description of project.' , 'Miscellaneous' ),
244
+ (
245
+ "index" ,
246
+ "kazoo" ,
247
+ "kazoo Documentation" ,
248
+ "Various Authors" ,
249
+ "kazoo" ,
250
+ "One line description of project." ,
251
+ "Miscellaneous" ,
252
+ ),
250
253
]
251
254
252
255
# Documents to append as an appendix to all manuals.
253
- #texinfo_appendices = []
256
+ # texinfo_appendices = []
254
257
255
258
# If false, no module index is generated.
256
- #texinfo_domain_indices = True
259
+ # texinfo_domain_indices = True
257
260
258
261
# How to display URL addresses: 'footnote', 'no', or 'inline'.
259
- #texinfo_show_urls = 'footnote'
262
+ # texinfo_show_urls = 'footnote'
0 commit comments