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