|
20 | 20 | # If extensions (or modules to document with autodoc) are in another directory,
|
21 | 21 | # add these directories to sys.path here. If the directory is relative to the
|
22 | 22 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
23 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 23 | +sys.path.insert(0, os.path.abspath("..")) |
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 |
| -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 31 | +# extensions coming with Sphinx (named "sphinx.ext.*") or your custom |
32 | 32 | # ones.
|
33 | 33 | extensions = [
|
34 |
| - 'alabaster', |
35 |
| - 'sphinx.ext.autodoc', |
36 |
| - 'sphinxcontrib.disqus', |
| 34 | + "alabaster", |
| 35 | + "sphinx.ext.autodoc", |
| 36 | + "sphinxcontrib.disqus", |
37 | 37 | ]
|
38 | 38 |
|
39 | 39 | # Add any paths that contain templates here, relative to this directory.
|
40 |
| -templates_path = ['_templates'] |
| 40 | +templates_path = ["_templates"] |
41 | 41 |
|
42 | 42 | # The suffix(es) of source filenames.
|
43 | 43 | # You can specify multiple suffix as a list of string:
|
44 |
| -# source_suffix = ['.rst', '.md'] |
45 |
| -source_suffix = '.rst' |
| 44 | +# source_suffix = [".rst", ".md"] |
| 45 | +source_suffix = ".rst" |
46 | 46 |
|
47 | 47 | # The encoding of source files.
|
48 |
| -#source_encoding = 'utf-8-sig' |
| 48 | +#source_encoding = "utf-8-sig" |
49 | 49 |
|
50 | 50 | # The master toctree document.
|
51 |
| -master_doc = 'index' |
| 51 | +master_doc = "index" |
52 | 52 |
|
53 | 53 | # General information about the project.
|
54 |
| -project = u'Dependency Injector' |
55 |
| -copyright = u'2021, Roman Mogylatov' |
56 |
| -author = u'Roman Mogylatov' |
| 54 | +project = "Dependency Injector" |
| 55 | +copyright = "2021, Roman Mogylatov" |
| 56 | +author = "Roman Mogylatov" |
57 | 57 |
|
58 |
| -# The version info for the project you're documenting, acts as replacement for |
| 58 | +# The version info for the project you"re documenting, acts as replacement for |
59 | 59 | # |version| and |release|, also used in various other places throughout the
|
60 | 60 | # built documents.
|
61 | 61 | #
|
62 | 62 | # The short X.Y version.
|
63 | 63 | # Getting version:
|
64 |
| -with open('../src/dependency_injector/__init__.py') as init_file: |
65 |
| - version = re.search('__version__ = \'(.*?)\'', init_file.read()).group(1) |
| 64 | +with open("../src/dependency_injector/__init__.py") as init_file: |
| 65 | + version = re.search("__version__ = \"(.*?)\"", init_file.read()).group(1) |
66 | 66 |
|
67 | 67 | # The full version, including alpha/beta/rc tags.
|
68 | 68 | release = version
|
|
76 | 76 |
|
77 | 77 | # There are two options for replacing |today|: either, you set today to some
|
78 | 78 | # non-false value, then it is used:
|
79 |
| -#today = '' |
| 79 | +#today = "" |
80 | 80 | # Else, today_fmt is used as the format for a strftime call.
|
81 |
| -#today_fmt = '%B %d, %Y' |
| 81 | +#today_fmt = "%B %d, %Y" |
82 | 82 |
|
83 | 83 | # List of patterns, relative to source directory, that match files and
|
84 | 84 | # directories to ignore when looking for source files.
|
85 |
| -exclude_patterns = ['_build'] |
| 85 | +exclude_patterns = ["_build"] |
86 | 86 |
|
87 | 87 | # The reST default role (used for this markup: `text`) to use for all
|
88 | 88 | # documents.
|
89 | 89 | #default_role = None
|
90 | 90 |
|
91 |
| -# If true, '()' will be appended to :func: etc. cross-reference text. |
| 91 | +# If true, "()" will be appended to :func: etc. cross-reference text. |
92 | 92 | #add_function_parentheses = True
|
93 | 93 |
|
94 | 94 | # If true, the current module name will be prepended to all description
|
|
100 | 100 | #show_authors = False
|
101 | 101 |
|
102 | 102 | # The name of the Pygments (syntax highlighting) style to use.
|
103 |
| -pygments_style = 'sphinx' |
| 103 | +pygments_style = "sphinx" |
104 | 104 |
|
105 | 105 | # A list of ignored prefixes for module index sorting.
|
106 | 106 | #modindex_common_prefix = []
|
|
116 | 116 |
|
117 | 117 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
118 | 118 | # a list of builtin themes.
|
119 |
| -# html_theme = 'sphinx_rtd_theme' |
120 |
| -html_theme = 'alabaster' |
| 119 | +# html_theme = "sphinx_rtd_theme" |
| 120 | +html_theme = "alabaster" |
121 | 121 |
|
122 | 122 | # Theme options are theme-specific and customize the look and feel of a theme
|
123 | 123 | # further. For a list of options available for each theme, see the
|
|
141 | 141 | # The name of an image file (within the static path) to use as favicon of the
|
142 | 142 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
143 | 143 | # pixels large.
|
144 |
| -html_favicon = 'favicon.ico' |
| 144 | +html_favicon = "favicon.ico" |
145 | 145 |
|
146 | 146 | # Add any paths that contain custom static files (such as style sheets) here,
|
147 | 147 | # relative to this directory. They are copied after the builtin static files,
|
148 | 148 | # so a file named "default.css" will overwrite the builtin "default.css".
|
149 |
| -html_static_path = ['_static'] |
| 149 | +html_static_path = ["_static"] |
150 | 150 |
|
151 | 151 | # Add any extra paths that contain custom files (such as robots.txt or
|
152 | 152 | # .htaccess) here, relative to this directory. These files are copied
|
153 | 153 | # directly to the root of the documentation.
|
154 | 154 | #html_extra_path = []
|
155 | 155 |
|
156 |
| -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 156 | +# If not "", a "Last updated on:" timestamp is inserted at every page bottom, |
157 | 157 | # using the given strftime format.
|
158 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 158 | +#html_last_updated_fmt = "%b %d, %Y" |
159 | 159 |
|
160 | 160 | # If true, SmartyPants will be used to convert quotes and dashes to
|
161 | 161 | # typographically correct entities.
|
|
189 | 189 | # If true, an OpenSearch description file will be output, and all pages will
|
190 | 190 | # contain a <link> tag referring to it. The value of this option must be the
|
191 | 191 | # base URL from which the finished HTML is served.
|
192 |
| -#html_use_opensearch = '' |
| 192 | +#html_use_opensearch = "" |
193 | 193 |
|
194 | 194 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
195 | 195 | #html_file_suffix = None
|
196 | 196 |
|
197 | 197 | # Language to be used for generating the HTML full-text search index.
|
198 | 198 | # Sphinx supports the following languages:
|
199 |
| -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
200 |
| -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
201 |
| -#html_search_language = 'en' |
| 199 | +# "da", "de", "en", "es", "fi", "fr", "hu", "it", "ja" |
| 200 | +# "nl", "no", "pt", "ro", "ru", "sv", "tr" |
| 201 | +#html_search_language = "en" |
202 | 202 |
|
203 | 203 | # A dictionary with options for the search language support, empty by default.
|
204 |
| -# Now only 'ja' uses this config value |
205 |
| -#html_search_options = {'type': 'default'} |
| 204 | +# Now only "ja" uses this config value |
| 205 | +#html_search_options = {"type": "default"} |
206 | 206 |
|
207 | 207 | # The name of a javascript file (relative to the configuration directory) that
|
208 | 208 | # implements a search results scorer. If empty, the default will be used.
|
209 |
| -#html_search_scorer = 'scorer.js' |
| 209 | +#html_search_scorer = "scorer.js" |
210 | 210 |
|
211 | 211 | # Output file base name for HTML help builder.
|
212 |
| -htmlhelp_basename = 'dependency_injectordoc' |
| 212 | +htmlhelp_basename = "dependency_injectordoc" |
213 | 213 |
|
214 | 214 | # -- Options for LaTeX output ---------------------------------------------
|
215 | 215 |
|
216 | 216 | latex_elements = {
|
217 |
| -# The paper size ('letterpaper' or 'a4paper'). |
218 |
| -#'papersize': 'letterpaper', |
| 217 | +# The paper size ("letterpaper" or "a4paper"). |
| 218 | +#"papersize": "letterpaper", |
219 | 219 |
|
220 |
| -# The font size ('10pt', '11pt' or '12pt'). |
221 |
| -#'pointsize': '10pt', |
| 220 | +# The font size ("10pt", "11pt" or "12pt"). |
| 221 | +#"pointsize": "10pt", |
222 | 222 |
|
223 | 223 | # Additional stuff for the LaTeX preamble.
|
224 |
| -#'preamble': '', |
| 224 | +#"preamble": "", |
225 | 225 |
|
226 | 226 | # Latex figure (float) alignment
|
227 |
| -#'figure_align': 'htbp', |
| 227 | +#"figure_align": "htbp", |
228 | 228 | }
|
229 | 229 |
|
230 | 230 | # Grouping the document tree into LaTeX files. List of tuples
|
231 | 231 | # (source start file, target name, title,
|
232 | 232 | # author, documentclass [howto, manual, or own class]).
|
233 | 233 | latex_documents = [
|
234 |
| - (master_doc, 'dependency_injector.tex', u'Dependency Injector Documentation', |
235 |
| - u'Roman Mogylatov', 'manual'), |
| 234 | + (master_doc, "dependency_injector.tex", u"Dependency Injector Documentation", |
| 235 | + u"Roman Mogylatov", "manual"), |
236 | 236 | ]
|
237 | 237 |
|
238 | 238 | # The name of an image file (relative to this directory) to place at the top of
|
|
261 | 261 | # One entry per manual page. List of tuples
|
262 | 262 | # (source start file, name, description, authors, manual section).
|
263 | 263 | man_pages = [
|
264 |
| - (master_doc, 'Dependency Injector', u'Dependency Injector Documentation', |
| 264 | + (master_doc, "Dependency Injector", u"Dependency Injector Documentation", |
265 | 265 | [author], 1)
|
266 | 266 | ]
|
267 | 267 |
|
|
275 | 275 | # (source start file, target name, title, author,
|
276 | 276 | # dir menu entry, description, category)
|
277 | 277 | texinfo_documents = [
|
278 |
| - (master_doc, 'Dependency Injector', u'Dependency Injector Documentation', |
279 |
| - author, 'Dependency Injector', 'Dependency injection microframework for Python', |
280 |
| - 'Miscellaneous'), |
| 278 | + (master_doc, "Dependency Injector", u"Dependency Injector Documentation", |
| 279 | + author, "Dependency Injector", "Dependency injection microframework for Python", |
| 280 | + "Miscellaneous"), |
281 | 281 | ]
|
282 | 282 |
|
283 | 283 | # Documents to append as an appendix to all manuals.
|
|
286 | 286 | # If false, no module index is generated.
|
287 | 287 | #texinfo_domain_indices = True
|
288 | 288 |
|
289 |
| -# How to display URL addresses: 'footnote', 'no', or 'inline'. |
290 |
| -#texinfo_show_urls = 'footnote' |
| 289 | +# How to display URL addresses: "footnote", "no", or "inline". |
| 290 | +#texinfo_show_urls = "footnote" |
291 | 291 |
|
292 |
| -# If true, do not generate a @detailmenu in the "Top" node's menu. |
| 292 | +# If true, do not generate a @detailmenu in the "Top" node"s menu. |
293 | 293 | #texinfo_no_detailmenu = False
|
294 | 294 |
|
295 |
| -autodoc_member_order = 'bysource' |
| 295 | +autodoc_member_order = "bysource" |
296 | 296 |
|
297 |
| -disqus_shortname = 'python-dependency-injector' |
| 297 | +disqus_shortname = "python-dependency-injector" |
298 | 298 |
|
299 | 299 | html_theme_options = {
|
300 |
| - 'github_user': 'ets-labs', |
301 |
| - 'github_repo': 'python-dependency-injector', |
302 |
| - 'github_type': 'star', |
303 |
| - 'github_button': True, |
304 |
| - 'github_banner': True, |
305 |
| - 'logo': 'logo.svg', |
306 |
| - 'description': 'Dependency injection framework for Python by Roman Mogylatov', |
307 |
| - 'code_font_size': '10pt', |
308 |
| - 'analytics_id': 'UA-67012059-1', |
| 300 | + "github_user": "ets-labs", |
| 301 | + "github_repo": "python-dependency-injector", |
| 302 | + "github_type": "star", |
| 303 | + "github_button": True, |
| 304 | + "github_banner": True, |
| 305 | + "logo": "logo.svg", |
| 306 | + "description": "Dependency injection framework for Python by Roman Mogylatov", |
| 307 | + "code_font_size": "10pt", |
| 308 | + "analytics_id": "UA-67012059-1", |
309 | 309 | }
|
0 commit comments