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