|
12 | 12 | # All configuration values have a default; values that are commented out
|
13 | 13 | # serve to show the default.
|
14 | 14 |
|
| 15 | +import sphinx_rtd_theme |
15 | 16 | import sys
|
16 | 17 | import os
|
17 | 18 | from glob import glob
|
|
41 | 42 |
|
42 | 43 |
|
43 | 44 | # If your documentation needs a minimal Sphinx version, state it here.
|
44 |
| -#needs_sphinx = '1.0' |
| 45 | +# needs_sphinx = '1.0' |
45 | 46 |
|
46 | 47 | # Add any Sphinx extension module names here, as strings. They can be
|
47 | 48 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
67 | 68 |
|
68 | 69 | # The language for content autogenerated by Sphinx. Refer to documentation
|
69 | 70 | # for a list of supported languages.
|
70 |
| -#language = None |
| 71 | +# language = None |
71 | 72 |
|
72 | 73 | # There are two options for replacing |today|: either, you set today to some
|
73 | 74 | # non-false value, then it is used:
|
74 |
| -#today = '' |
| 75 | +# today = '' |
75 | 76 | # Else, today_fmt is used as the format for a strftime call.
|
76 |
| -#today_fmt = '%B %d, %Y' |
| 77 | +# today_fmt = '%B %d, %Y' |
77 | 78 |
|
78 | 79 | # List of patterns, relative to source directory, that match files and
|
79 | 80 | # directories to ignore when looking for source files.
|
80 | 81 | exclude_patterns = ['_build']
|
81 | 82 |
|
82 | 83 | # The reST default role (used for this markup: `text`) to use for all
|
83 | 84 | # documents.
|
84 |
| -#default_role = None |
| 85 | +# default_role = None |
85 | 86 |
|
86 | 87 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
87 |
| -#add_function_parentheses = True |
| 88 | +# add_function_parentheses = True |
88 | 89 |
|
89 | 90 | # If true, the current module name will be prepended to all description
|
90 | 91 | # unit titles (such as .. function::).
|
91 |
| -#add_module_names = True |
| 92 | +# add_module_names = True |
92 | 93 |
|
93 | 94 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
94 | 95 | # output. They are ignored by default.
|
95 |
| -#show_authors = False |
| 96 | +# show_authors = False |
96 | 97 |
|
97 | 98 | # The name of the Pygments (syntax highlighting) style to use.
|
98 | 99 | pygments_style = 'sphinx'
|
99 | 100 |
|
100 | 101 | # A list of ignored prefixes for module index sorting.
|
101 |
| -#modindex_common_prefix = [] |
| 102 | +# modindex_common_prefix = [] |
102 | 103 |
|
103 | 104 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
104 |
| -#keep_warnings = False |
| 105 | +# keep_warnings = False |
105 | 106 |
|
106 | 107 |
|
107 | 108 | # -- Options for HTML output ----------------------------------------------
|
108 | 109 |
|
109 |
| -import sphinx_rtd_theme |
110 | 110 |
|
111 | 111 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
112 | 112 | # a list of builtin themes.
|
|
118 | 118 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
119 | 119 |
|
120 | 120 | # Add any paths that contain custom themes here, relative to this directory.
|
121 |
| -#html_theme_path = [] |
| 121 | +# html_theme_path = [] |
122 | 122 |
|
123 | 123 | # The name for this set of Sphinx documents. If None, it defaults to
|
124 | 124 | # "<project> v<release> documentation".
|
125 |
| -#html_title = None |
| 125 | +# html_title = None |
126 | 126 |
|
127 | 127 | # A shorter title for the navigation bar. Default is the same as html_title.
|
128 |
| -#html_short_title = None |
| 128 | +# html_short_title = None |
129 | 129 |
|
130 | 130 | # The name of an image file (relative to this directory) to place at the top
|
131 | 131 | # of the sidebar.
|
132 |
| -#html_logo = None |
| 132 | +# html_logo = None |
133 | 133 |
|
134 | 134 | # The name of an image file (within the static path) to use as favicon of the
|
135 | 135 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
136 | 136 | # pixels large.
|
137 |
| -#html_favicon = None |
| 137 | +# html_favicon = None |
138 | 138 |
|
139 | 139 | # Add any paths that contain custom static files (such as style sheets) here,
|
140 | 140 | # relative to this directory. They are copied after the builtin static files,
|
141 | 141 | # so a file named "default.css" will overwrite the builtin "default.css".
|
142 |
| -#html_static_path = ['_static'] |
| 142 | +# html_static_path = ['_static'] |
143 | 143 |
|
144 | 144 | # Add any extra paths that contain custom files (such as robots.txt or
|
145 | 145 | # .htaccess) here, relative to this directory. These files are copied
|
146 | 146 | # directly to the root of the documentation.
|
147 |
| -#html_extra_path = [] |
| 147 | +# html_extra_path = [] |
148 | 148 |
|
149 | 149 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
150 | 150 | # using the given strftime format.
|
151 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 151 | +# html_last_updated_fmt = '%b %d, %Y' |
152 | 152 |
|
153 | 153 | # If true, SmartyPants will be used to convert quotes and dashes to
|
154 | 154 | # typographically correct entities.
|
155 |
| -#html_use_smartypants = True |
| 155 | +# html_use_smartypants = True |
156 | 156 |
|
157 | 157 | # Custom sidebar templates, maps document names to template names.
|
158 |
| -#html_sidebars = {} |
| 158 | +# html_sidebars = {} |
159 | 159 |
|
160 | 160 | # Additional templates that should be rendered to pages, maps page names to
|
161 | 161 | # template names.
|
162 |
| -#html_additional_pages = {} |
| 162 | +# html_additional_pages = {} |
163 | 163 |
|
164 | 164 | # If false, no module index is generated.
|
165 |
| -#html_domain_indices = True |
| 165 | +# html_domain_indices = True |
166 | 166 |
|
167 | 167 | # If false, no index is generated.
|
168 |
| -#html_use_index = True |
| 168 | +# html_use_index = True |
169 | 169 |
|
170 | 170 | # If true, the index is split into individual pages for each letter.
|
171 |
| -#html_split_index = False |
| 171 | +# html_split_index = False |
172 | 172 |
|
173 | 173 | # If true, links to the reST sources are added to the pages.
|
174 |
| -#html_show_sourcelink = True |
| 174 | +# html_show_sourcelink = True |
175 | 175 |
|
176 | 176 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
177 |
| -#html_show_sphinx = True |
| 177 | +# html_show_sphinx = True |
178 | 178 |
|
179 | 179 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
180 |
| -#html_show_copyright = True |
| 180 | +# html_show_copyright = True |
181 | 181 |
|
182 | 182 | # If true, an OpenSearch description file will be output, and all pages will
|
183 | 183 | # contain a <link> tag referring to it. The value of this option must be the
|
184 | 184 | # base URL from which the finished HTML is served.
|
185 |
| -#html_use_opensearch = '' |
| 185 | +# html_use_opensearch = '' |
186 | 186 |
|
187 | 187 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
188 |
| -#html_file_suffix = None |
| 188 | +# html_file_suffix = None |
189 | 189 |
|
190 | 190 | # Output file base name for HTML help builder.
|
191 | 191 | htmlhelp_basename = 'confluent-kafkadoc'
|
|
194 | 194 | # -- Options for LaTeX output ---------------------------------------------
|
195 | 195 |
|
196 | 196 | latex_elements = {
|
197 |
| -# The paper size ('letterpaper' or 'a4paper'). |
198 |
| -#'papersize': 'letterpaper', |
| 197 | + # The paper size ('letterpaper' or 'a4paper'). |
| 198 | + # 'papersize': 'letterpaper', |
199 | 199 |
|
200 |
| -# The font size ('10pt', '11pt' or '12pt'). |
201 |
| -#'pointsize': '10pt', |
| 200 | + # The font size ('10pt', '11pt' or '12pt'). |
| 201 | + # 'pointsize': '10pt', |
202 | 202 |
|
203 |
| -# Additional stuff for the LaTeX preamble. |
204 |
| -#'preamble': '', |
| 203 | + # Additional stuff for the LaTeX preamble. |
| 204 | + # 'preamble': '', |
205 | 205 | }
|
206 | 206 |
|
207 | 207 | # Grouping the document tree into LaTeX files. List of tuples
|
208 | 208 | # (source start file, target name, title,
|
209 | 209 | # author, documentclass [howto, manual, or own class]).
|
210 | 210 | latex_documents = [
|
211 |
| - ('index', 'confluent-kafka.tex', u'confluent-kafka Documentation', |
212 |
| - u'Magnus Edenhill', 'manual'), |
| 211 | + ('index', 'confluent-kafka.tex', u'confluent-kafka Documentation', |
| 212 | + u'Magnus Edenhill', 'manual'), |
213 | 213 | ]
|
214 | 214 |
|
215 | 215 | # The name of an image file (relative to this directory) to place at the top of
|
216 | 216 | # the title page.
|
217 |
| -#latex_logo = None |
| 217 | +# latex_logo = None |
218 | 218 |
|
219 | 219 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
220 | 220 | # not chapters.
|
221 |
| -#latex_use_parts = False |
| 221 | +# latex_use_parts = False |
222 | 222 |
|
223 | 223 | # If true, show page references after internal links.
|
224 |
| -#latex_show_pagerefs = False |
| 224 | +# latex_show_pagerefs = False |
225 | 225 |
|
226 | 226 | # If true, show URL addresses after external links.
|
227 |
| -#latex_show_urls = False |
| 227 | +# latex_show_urls = False |
228 | 228 |
|
229 | 229 | # Documents to append as an appendix to all manuals.
|
230 |
| -#latex_appendices = [] |
| 230 | +# latex_appendices = [] |
231 | 231 |
|
232 | 232 | # If false, no module index is generated.
|
233 |
| -#latex_domain_indices = True |
| 233 | +# latex_domain_indices = True |
234 | 234 |
|
235 | 235 |
|
236 | 236 | # -- Options for manual page output ---------------------------------------
|
|
243 | 243 | ]
|
244 | 244 |
|
245 | 245 | # If true, show URL addresses after external links.
|
246 |
| -#man_show_urls = False |
| 246 | +# man_show_urls = False |
247 | 247 |
|
248 | 248 |
|
249 | 249 | # -- Options for Texinfo output -------------------------------------------
|
|
252 | 252 | # (source start file, target name, title, author,
|
253 | 253 | # dir menu entry, description, category)
|
254 | 254 | texinfo_documents = [
|
255 |
| - ('index', 'confluent-kafka', u'confluent-kafka Documentation', |
256 |
| - u'Magnus Edenhill', 'confluent-kafka', 'One line description of project.', |
257 |
| - 'Miscellaneous'), |
| 255 | + ('index', 'confluent-kafka', u'confluent-kafka Documentation', |
| 256 | + u'Magnus Edenhill', 'confluent-kafka', 'One line description of project.', |
| 257 | + 'Miscellaneous'), |
258 | 258 | ]
|
259 | 259 |
|
260 | 260 | # Documents to append as an appendix to all manuals.
|
261 |
| -#texinfo_appendices = [] |
| 261 | +# texinfo_appendices = [] |
262 | 262 |
|
263 | 263 | # If false, no module index is generated.
|
264 |
| -#texinfo_domain_indices = True |
| 264 | +# texinfo_domain_indices = True |
265 | 265 |
|
266 | 266 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
267 |
| -#texinfo_show_urls = 'footnote' |
| 267 | +# texinfo_show_urls = 'footnote' |
268 | 268 |
|
269 | 269 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
270 |
| -#texinfo_no_detailmenu = False |
| 270 | +# texinfo_no_detailmenu = False |
271 | 271 |
|
272 | 272 | autodoc_member_order = 'bysource'
|
0 commit comments