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