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