|
18 | 18 | # If extensions (or modules to document with autodoc) are in another directory, |
19 | 19 | # add these directories to sys.path here. If the directory is relative to the |
20 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
21 | | -sys.path.insert(0, os.path.abspath('..')) |
| 21 | +sys.path.insert(0, os.path.abspath("..")) |
22 | 22 |
|
23 | | -__version__ = '0.90.4' |
| 23 | +__version__ = "0.90.4" |
24 | 24 |
|
25 | 25 | # -- General configuration ------------------------------------------------ |
26 | 26 |
|
27 | 27 | # If your documentation needs a minimal Sphinx version, state it here. |
28 | | -#needs_sphinx = '1.0' |
| 28 | +# needs_sphinx = '1.0' |
29 | 29 |
|
30 | 30 | # Add any Sphinx extension module names here, as strings. They can be |
31 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
32 | 32 | # ones. |
33 | 33 | extensions = [ |
34 | | - 'sphinx.ext.autodoc', |
35 | | - 'sphinx.ext.autosummary', |
36 | | - 'sphinx.ext.doctest', |
37 | | - 'sphinx.ext.intersphinx', |
38 | | - 'sphinx.ext.coverage', |
39 | | - 'sphinx.ext.napoleon', |
40 | | - 'sphinx.ext.viewcode', |
| 34 | + "sphinx.ext.autodoc", |
| 35 | + "sphinx.ext.autosummary", |
| 36 | + "sphinx.ext.doctest", |
| 37 | + "sphinx.ext.intersphinx", |
| 38 | + "sphinx.ext.coverage", |
| 39 | + "sphinx.ext.napoleon", |
| 40 | + "sphinx.ext.viewcode", |
41 | 41 | ] |
42 | 42 |
|
43 | 43 | # autodoc/autosummary flags |
44 | | -autoclass_content = 'both' |
45 | | -autodoc_default_flags = ['members'] |
| 44 | +autoclass_content = "both" |
| 45 | +autodoc_default_flags = ["members"] |
46 | 46 | autosummary_generate = True |
47 | 47 |
|
48 | 48 | # Add any paths that contain templates here, relative to this directory. |
49 | | -templates_path = ['_templates'] |
| 49 | +templates_path = ["_templates"] |
50 | 50 |
|
51 | 51 | # Allow markdown includes (so releases.md can include CHANGLEOG.md) |
52 | 52 | # http://www.sphinx-doc.org/en/master/markdown.html |
53 | | -source_parsers = { |
54 | | - '.md': 'recommonmark.parser.CommonMarkParser', |
55 | | -} |
| 53 | +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} |
56 | 54 |
|
57 | 55 | # The suffix(es) of source filenames. |
58 | 56 | # You can specify multiple suffix as a list of string: |
59 | 57 | # source_suffix = ['.rst', '.md'] |
60 | | -source_suffix = '.rst' |
| 58 | +source_suffix = ".rst" |
61 | 59 |
|
62 | 60 | # The encoding of source files. |
63 | | -#source_encoding = 'utf-8-sig' |
| 61 | +# source_encoding = 'utf-8-sig' |
64 | 62 |
|
65 | 63 | # The master toctree document. |
66 | | -master_doc = 'index' |
| 64 | +master_doc = "index" |
67 | 65 |
|
68 | 66 | # General information about the project. |
69 | | -project = u'google-cloud-spanner' |
70 | | -copyright = u'2017, Google' |
71 | | -author = u'Google APIs' |
| 67 | +project = u"google-cloud-spanner" |
| 68 | +copyright = u"2017, Google" |
| 69 | +author = u"Google APIs" |
72 | 70 |
|
73 | 71 | # The version info for the project you're documenting, acts as replacement for |
74 | 72 | # |version| and |release|, also used in various other places throughout the |
|
77 | 75 | # The full version, including alpha/beta/rc tags. |
78 | 76 | release = __version__ |
79 | 77 | # The short X.Y version. |
80 | | -version = '.'.join(release.split('.')[0:2]) |
| 78 | +version = ".".join(release.split(".")[0:2]) |
81 | 79 |
|
82 | 80 | # The language for content autogenerated by Sphinx. Refer to documentation |
83 | 81 | # for a list of supported languages. |
|
88 | 86 |
|
89 | 87 | # There are two options for replacing |today|: either, you set today to some |
90 | 88 | # non-false value, then it is used: |
91 | | -#today = '' |
| 89 | +# today = '' |
92 | 90 | # Else, today_fmt is used as the format for a strftime call. |
93 | | -#today_fmt = '%B %d, %Y' |
| 91 | +# today_fmt = '%B %d, %Y' |
94 | 92 |
|
95 | 93 | # List of patterns, relative to source directory, that match files and |
96 | 94 | # directories to ignore when looking for source files. |
97 | | -exclude_patterns = ['_build'] |
| 95 | +exclude_patterns = ["_build"] |
98 | 96 |
|
99 | 97 | # The reST default role (used for this markup: `text`) to use for all |
100 | 98 | # documents. |
101 | | -#default_role = None |
| 99 | +# default_role = None |
102 | 100 |
|
103 | 101 | # If true, '()' will be appended to :func: etc. cross-reference text. |
104 | | -#add_function_parentheses = True |
| 102 | +# add_function_parentheses = True |
105 | 103 |
|
106 | 104 | # If true, the current module name will be prepended to all description |
107 | 105 | # unit titles (such as .. function::). |
108 | | -#add_module_names = True |
| 106 | +# add_module_names = True |
109 | 107 |
|
110 | 108 | # If true, sectionauthor and moduleauthor directives will be shown in the |
111 | 109 | # output. They are ignored by default. |
112 | | -#show_authors = False |
| 110 | +# show_authors = False |
113 | 111 |
|
114 | 112 | # The name of the Pygments (syntax highlighting) style to use. |
115 | | -pygments_style = 'sphinx' |
| 113 | +pygments_style = "sphinx" |
116 | 114 |
|
117 | 115 | # A list of ignored prefixes for module index sorting. |
118 | | -#modindex_common_prefix = [] |
| 116 | +# modindex_common_prefix = [] |
119 | 117 |
|
120 | 118 | # If true, keep warnings as "system message" paragraphs in the built documents. |
121 | | -#keep_warnings = False |
| 119 | +# keep_warnings = False |
122 | 120 |
|
123 | 121 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
124 | 122 | todo_include_todos = True |
|
127 | 125 |
|
128 | 126 | # The theme to use for HTML and HTML Help pages. See the documentation for |
129 | 127 | # a list of builtin themes. |
130 | | -html_theme = 'alabaster' |
| 128 | +html_theme = "alabaster" |
131 | 129 |
|
132 | 130 | # Theme options are theme-specific and customize the look and feel of a theme |
133 | 131 | # further. For a list of options available for each theme, see the |
134 | 132 | # documentation. |
135 | | -#html_theme_options = {} |
| 133 | +# html_theme_options = {} |
136 | 134 |
|
137 | 135 | # Add any paths that contain custom themes here, relative to this directory. |
138 | | -#html_theme_path = [] |
| 136 | +# html_theme_path = [] |
139 | 137 |
|
140 | 138 | # The name for this set of Sphinx documents. If None, it defaults to |
141 | 139 | # "<project> v<release> documentation". |
142 | | -#html_title = None |
| 140 | +# html_title = None |
143 | 141 |
|
144 | 142 | # A shorter title for the navigation bar. Default is the same as html_title. |
145 | | -#html_short_title = None |
| 143 | +# html_short_title = None |
146 | 144 |
|
147 | 145 | # The name of an image file (relative to this directory) to place at the top |
148 | 146 | # of the sidebar. |
149 | | -#html_logo = None |
| 147 | +# html_logo = None |
150 | 148 |
|
151 | 149 | # The name of an image file (within the static path) to use as favicon of the |
152 | 150 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
153 | 151 | # pixels large. |
154 | | -#html_favicon = None |
| 152 | +# html_favicon = None |
155 | 153 |
|
156 | 154 | # Add any paths that contain custom static files (such as style sheets) here, |
157 | 155 | # relative to this directory. They are copied after the builtin static files, |
|
161 | 159 | # Add any extra paths that contain custom files (such as robots.txt or |
162 | 160 | # .htaccess) here, relative to this directory. These files are copied |
163 | 161 | # directly to the root of the documentation. |
164 | | -#html_extra_path = [] |
| 162 | +# html_extra_path = [] |
165 | 163 |
|
166 | 164 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
167 | 165 | # using the given strftime format. |
168 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 166 | +# html_last_updated_fmt = '%b %d, %Y' |
169 | 167 |
|
170 | 168 | # If true, SmartyPants will be used to convert quotes and dashes to |
171 | 169 | # typographically correct entities. |
172 | | -#html_use_smartypants = True |
| 170 | +# html_use_smartypants = True |
173 | 171 |
|
174 | 172 | # Custom sidebar templates, maps document names to template names. |
175 | | -#html_sidebars = {} |
| 173 | +# html_sidebars = {} |
176 | 174 |
|
177 | 175 | # Additional templates that should be rendered to pages, maps page names to |
178 | 176 | # template names. |
179 | | -#html_additional_pages = {} |
| 177 | +# html_additional_pages = {} |
180 | 178 |
|
181 | 179 | # If false, no module index is generated. |
182 | | -#html_domain_indices = True |
| 180 | +# html_domain_indices = True |
183 | 181 |
|
184 | 182 | # If false, no index is generated. |
185 | | -#html_use_index = True |
| 183 | +# html_use_index = True |
186 | 184 |
|
187 | 185 | # If true, the index is split into individual pages for each letter. |
188 | | -#html_split_index = False |
| 186 | +# html_split_index = False |
189 | 187 |
|
190 | 188 | # If true, links to the reST sources are added to the pages. |
191 | | -#html_show_sourcelink = True |
| 189 | +# html_show_sourcelink = True |
192 | 190 |
|
193 | 191 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
194 | | -#html_show_sphinx = True |
| 192 | +# html_show_sphinx = True |
195 | 193 |
|
196 | 194 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
197 | | -#html_show_copyright = True |
| 195 | +# html_show_copyright = True |
198 | 196 |
|
199 | 197 | # If true, an OpenSearch description file will be output, and all pages will |
200 | 198 | # contain a <link> tag referring to it. The value of this option must be the |
201 | 199 | # base URL from which the finished HTML is served. |
202 | | -#html_use_opensearch = '' |
| 200 | +# html_use_opensearch = '' |
203 | 201 |
|
204 | 202 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
205 | | -#html_file_suffix = None |
| 203 | +# html_file_suffix = None |
206 | 204 |
|
207 | 205 | # Language to be used for generating the HTML full-text search index. |
208 | 206 | # Sphinx supports the following languages: |
209 | 207 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
210 | 208 | # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
211 | | -#html_search_language = 'en' |
| 209 | +# html_search_language = 'en' |
212 | 210 |
|
213 | 211 | # A dictionary with options for the search language support, empty by default. |
214 | 212 | # Now only 'ja' uses this config value |
215 | | -#html_search_options = {'type': 'default'} |
| 213 | +# html_search_options = {'type': 'default'} |
216 | 214 |
|
217 | 215 | # The name of a javascript file (relative to the configuration directory) that |
218 | 216 | # implements a search results scorer. If empty, the default will be used. |
219 | | -#html_search_scorer = 'scorer.js' |
| 217 | +# html_search_scorer = 'scorer.js' |
220 | 218 |
|
221 | 219 | # Output file base name for HTML help builder. |
222 | | -htmlhelp_basename = 'google-cloud-spanner-doc' |
| 220 | +htmlhelp_basename = "google-cloud-spanner-doc" |
223 | 221 |
|
224 | 222 | # -- Options for LaTeX output --------------------------------------------- |
225 | 223 |
|
226 | 224 | latex_elements = { |
227 | 225 | # The paper size ('letterpaper' or 'a4paper'). |
228 | 226 | #'papersize': 'letterpaper', |
229 | | - |
230 | 227 | # The font size ('10pt', '11pt' or '12pt'). |
231 | 228 | #'pointsize': '10pt', |
232 | | - |
233 | 229 | # Additional stuff for the LaTeX preamble. |
234 | 230 | #'preamble': '', |
235 | | - |
236 | 231 | # Latex figure (float) alignment |
237 | 232 | #'figure_align': 'htbp', |
238 | 233 | } |
|
241 | 236 | # (source start file, target name, title, |
242 | 237 | # author, documentclass [howto, manual, or own class]). |
243 | 238 | latex_documents = [ |
244 | | - (master_doc, 'google-cloud-spanner.tex', |
245 | | - u'google-cloud-spanner Documentation', author, 'manual'), |
| 239 | + ( |
| 240 | + master_doc, |
| 241 | + "google-cloud-spanner.tex", |
| 242 | + u"google-cloud-spanner Documentation", |
| 243 | + author, |
| 244 | + "manual", |
| 245 | + ) |
246 | 246 | ] |
247 | 247 |
|
248 | 248 | # The name of an image file (relative to this directory) to place at the top of |
249 | 249 | # the title page. |
250 | | -#latex_logo = None |
| 250 | +# latex_logo = None |
251 | 251 |
|
252 | 252 | # For "manual" documents, if this is true, then toplevel headings are parts, |
253 | 253 | # not chapters. |
254 | | -#latex_use_parts = False |
| 254 | +# latex_use_parts = False |
255 | 255 |
|
256 | 256 | # If true, show page references after internal links. |
257 | | -#latex_show_pagerefs = False |
| 257 | +# latex_show_pagerefs = False |
258 | 258 |
|
259 | 259 | # If true, show URL addresses after external links. |
260 | | -#latex_show_urls = False |
| 260 | +# latex_show_urls = False |
261 | 261 |
|
262 | 262 | # Documents to append as an appendix to all manuals. |
263 | | -#latex_appendices = [] |
| 263 | +# latex_appendices = [] |
264 | 264 |
|
265 | 265 | # If false, no module index is generated. |
266 | | -#latex_domain_indices = True |
| 266 | +# latex_domain_indices = True |
267 | 267 |
|
268 | 268 | # -- Options for manual page output --------------------------------------- |
269 | 269 |
|
270 | 270 | # One entry per manual page. List of tuples |
271 | 271 | # (source start file, name, description, authors, manual section). |
272 | | -man_pages = [(master_doc, 'google-cloud-spanner', |
273 | | - u'google-cloud-spanner Documentation', [author], 1)] |
| 272 | +man_pages = [ |
| 273 | + ( |
| 274 | + master_doc, |
| 275 | + "google-cloud-spanner", |
| 276 | + u"google-cloud-spanner Documentation", |
| 277 | + [author], |
| 278 | + 1, |
| 279 | + ) |
| 280 | +] |
274 | 281 |
|
275 | 282 | # If true, show URL addresses after external links. |
276 | | -#man_show_urls = False |
| 283 | +# man_show_urls = False |
277 | 284 |
|
278 | 285 | # -- Options for Texinfo output ------------------------------------------- |
279 | 286 |
|
280 | 287 | # Grouping the document tree into Texinfo files. List of tuples |
281 | 288 | # (source start file, target name, title, author, |
282 | 289 | # dir menu entry, description, category) |
283 | 290 | texinfo_documents = [ |
284 | | - (master_doc, 'google-cloud-spanner', |
285 | | - u'google-cloud-spanner Documentation', author, 'google-cloud-spanner', |
286 | | - 'GAPIC library for the {metadata.shortName} v1 service', 'APIs'), |
| 291 | + ( |
| 292 | + master_doc, |
| 293 | + "google-cloud-spanner", |
| 294 | + u"google-cloud-spanner Documentation", |
| 295 | + author, |
| 296 | + "google-cloud-spanner", |
| 297 | + "GAPIC library for the {metadata.shortName} v1 service", |
| 298 | + "APIs", |
| 299 | + ) |
287 | 300 | ] |
288 | 301 |
|
289 | 302 | # Documents to append as an appendix to all manuals. |
290 | | -#texinfo_appendices = [] |
| 303 | +# texinfo_appendices = [] |
291 | 304 |
|
292 | 305 | # If false, no module index is generated. |
293 | | -#texinfo_domain_indices = True |
| 306 | +# texinfo_domain_indices = True |
294 | 307 |
|
295 | 308 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
296 | | -#texinfo_show_urls = 'footnote' |
| 309 | +# texinfo_show_urls = 'footnote' |
297 | 310 |
|
298 | 311 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
299 | | -#texinfo_no_detailmenu = False |
| 312 | +# texinfo_no_detailmenu = False |
300 | 313 |
|
301 | 314 | # Example configuration for intersphinx: refer to the Python standard library. |
302 | 315 | intersphinx_mapping = { |
303 | | - 'python': ('http://python.readthedocs.org/en/latest/', None), |
304 | | - 'gax': ('https://gax-python.readthedocs.org/en/latest/', None), |
| 316 | + "python": ("http://python.readthedocs.org/en/latest/", None), |
| 317 | + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), |
305 | 318 | } |
306 | 319 |
|
307 | 320 | # Napoleon settings |
|
0 commit comments