|
20 | 20 | import sys
|
21 | 21 | from pkg_resources import get_distribution
|
22 | 22 |
|
23 |
| -sys.path.insert(0, os.path.abspath('..')) |
24 |
| -sys.path.insert(0, os.path.abspath('../src')) |
| 23 | +sys.path.insert(0, os.path.abspath("..")) |
| 24 | +sys.path.insert(0, os.path.abspath("../src")) |
25 | 25 |
|
26 |
| -os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.settings' |
| 26 | +os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings" |
27 | 27 |
|
28 | 28 | # -- General configuration ------------------------------------------------
|
29 | 29 |
|
|
35 | 35 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
36 | 36 | # ones.
|
37 | 37 | extensions = [
|
38 |
| - 'sphinx.ext.autodoc', |
39 |
| - 'sphinx.ext.intersphinx', |
40 |
| - 'sphinx.ext.viewcode', |
41 |
| - 'sphinxcontrib.httpdomain', |
| 38 | + "sphinx.ext.autodoc", |
| 39 | + "sphinx.ext.intersphinx", |
| 40 | + "sphinx.ext.viewcode", |
| 41 | + "sphinxcontrib.httpdomain", |
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(es) of source filenames.
|
48 | 48 | # You can specify multiple suffix as a list of string:
|
49 | 49 | #
|
50 | 50 | # source_suffix = ['.rst', '.md']
|
51 |
| -source_suffix = '.rst' |
| 51 | +source_suffix = ".rst" |
52 | 52 |
|
53 | 53 | # The encoding of source files.
|
54 | 54 | #
|
55 | 55 | # source_encoding = 'utf-8-sig'
|
56 | 56 |
|
57 | 57 | # The master toctree document.
|
58 |
| -master_doc = 'index' |
| 58 | +master_doc = "index" |
59 | 59 |
|
60 | 60 | # General information about the project.
|
61 |
| -project = u'python-dockerflow' |
62 |
| -copyright = u'2016, Mozilla Foundation' |
63 |
| -author = u'Mozilla Foundation' |
| 61 | +project = u"python-dockerflow" |
| 62 | +copyright = u"2016, Mozilla Foundation" |
| 63 | +author = u"Mozilla Foundation" |
64 | 64 |
|
65 | 65 | # The version info for the project you're documenting, acts as replacement for
|
66 | 66 | # |version| and |release|, also used in various other places throughout the
|
67 | 67 | # built documents.
|
68 | 68 | #
|
69 | 69 | # The full version, including alpha/beta/rc tags.
|
70 |
| -release = get_distribution('dockerflow').version |
| 70 | +release = get_distribution("dockerflow").version |
71 | 71 | # The short X.Y version.
|
72 |
| -version = '.'.join(release.split('.')[:2]) |
| 72 | +version = ".".join(release.split(".")[:2]) |
73 | 73 |
|
74 | 74 | # The language for content autogenerated by Sphinx. Refer to documentation
|
75 | 75 | # for a list of supported languages.
|
|
90 | 90 | # List of patterns, relative to source directory, that match files and
|
91 | 91 | # directories to ignore when looking for source files.
|
92 | 92 | # This patterns also effect to html_static_path and html_extra_path
|
93 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 93 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
94 | 94 |
|
95 | 95 | # The reST default role (used for this markup: `text`) to use for all
|
96 | 96 | # documents.
|
|
112 | 112 | # show_authors = False
|
113 | 113 |
|
114 | 114 | # The name of the Pygments (syntax highlighting) style to use.
|
115 |
| -pygments_style = 'sphinx' |
| 115 | +pygments_style = "sphinx" |
116 | 116 |
|
117 | 117 | # A list of ignored prefixes for module index sorting.
|
118 | 118 | # modindex_common_prefix = []
|
|
129 | 129 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
130 | 130 | # a list of builtin themes.
|
131 | 131 | #
|
132 |
| -html_theme = 'default' |
| 132 | +html_theme = "default" |
133 | 133 |
|
134 | 134 | # Theme options are theme-specific and customize the look and feel of a theme
|
135 | 135 | # further. For a list of options available for each theme, see the
|
|
243 | 243 | # html_search_scorer = 'scorer.js'
|
244 | 244 |
|
245 | 245 | # Output file base name for HTML help builder.
|
246 |
| -htmlhelp_basename = 'python-dockerflowdoc' |
| 246 | +htmlhelp_basename = "python-dockerflowdoc" |
247 | 247 |
|
248 | 248 | # -- Options for LaTeX output ---------------------------------------------
|
249 | 249 |
|
250 | 250 | latex_elements = {
|
251 |
| - # The paper size ('letterpaper' or 'a4paper'). |
252 |
| - # |
253 |
| - # 'papersize': 'letterpaper', |
254 |
| - |
255 |
| - # The font size ('10pt', '11pt' or '12pt'). |
256 |
| - # |
257 |
| - # 'pointsize': '10pt', |
258 |
| - |
259 |
| - # Additional stuff for the LaTeX preamble. |
260 |
| - # |
261 |
| - # 'preamble': '', |
262 |
| - |
263 |
| - # Latex figure (float) alignment |
264 |
| - # |
265 |
| - # 'figure_align': 'htbp', |
| 251 | + # The paper size ('letterpaper' or 'a4paper'). |
| 252 | + # |
| 253 | + # 'papersize': 'letterpaper', |
| 254 | + # The font size ('10pt', '11pt' or '12pt'). |
| 255 | + # |
| 256 | + # 'pointsize': '10pt', |
| 257 | + # Additional stuff for the LaTeX preamble. |
| 258 | + # |
| 259 | + # 'preamble': '', |
| 260 | + # Latex figure (float) alignment |
| 261 | + # |
| 262 | + # 'figure_align': 'htbp', |
266 | 263 | }
|
267 | 264 |
|
268 | 265 | # Grouping the document tree into LaTeX files. List of tuples
|
269 | 266 | # (source start file, target name, title,
|
270 | 267 | # author, documentclass [howto, manual, or own class]).
|
271 | 268 | latex_documents = [
|
272 |
| - (master_doc, 'python-dockerflow.tex', u'python-dockerflow Documentation', |
273 |
| - u'Mozilla Foundation', 'manual'), |
| 269 | + ( |
| 270 | + master_doc, |
| 271 | + "python-dockerflow.tex", |
| 272 | + u"python-dockerflow Documentation", |
| 273 | + u"Mozilla Foundation", |
| 274 | + "manual", |
| 275 | + ) |
274 | 276 | ]
|
275 | 277 |
|
276 | 278 | # The name of an image file (relative to this directory) to place at the top of
|
|
311 | 313 | # One entry per manual page. List of tuples
|
312 | 314 | # (source start file, name, description, authors, manual section).
|
313 | 315 | man_pages = [
|
314 |
| - (master_doc, 'python-dockerflow', u'python-dockerflow Documentation', |
315 |
| - [author], 1) |
| 316 | + (master_doc, "python-dockerflow", u"python-dockerflow Documentation", [author], 1) |
316 | 317 | ]
|
317 | 318 |
|
318 | 319 | # If true, show URL addresses after external links.
|
|
326 | 327 | # (source start file, target name, title, author,
|
327 | 328 | # dir menu entry, description, category)
|
328 | 329 | texinfo_documents = [
|
329 |
| - (master_doc, 'python-dockerflow', u'python-dockerflow Documentation', |
330 |
| - author, 'python-dockerflow', 'One line description of project.', |
331 |
| - 'Miscellaneous'), |
| 330 | + ( |
| 331 | + master_doc, |
| 332 | + "python-dockerflow", |
| 333 | + u"python-dockerflow Documentation", |
| 334 | + author, |
| 335 | + "python-dockerflow", |
| 336 | + "One line description of project.", |
| 337 | + "Miscellaneous", |
| 338 | + ) |
332 | 339 | ]
|
333 | 340 |
|
334 | 341 | # Documents to append as an appendix to all manuals.
|
|
350 | 357 |
|
351 | 358 | # Example configuration for intersphinx: refer to the Python standard library.
|
352 | 359 | intersphinx_mapping = {
|
353 |
| - 'django': ('http://docs.djangoproject.com/en/stable/', |
354 |
| - 'http://docs.djangoproject.com/en/stable/_objects/'), |
355 |
| - 'flask': ('http://flask.pocoo.org/docs/', None), |
356 |
| - 'redis-py': ('https://redis-py.readthedocs.io/en/latest/', None), |
357 |
| - 'flask-sqlalchemy': ('https://flask-sqlalchemy.readthedocs.io/en/2.x/', None), |
358 |
| - 'python': ('https://docs.python.org/', None), |
359 |
| - 'whitenoise': ('https://whitenoise.readthedocs.io/en/stable/', None), |
360 |
| - 'sanic': ('https://sanic.readthedocs.io/en/stable/', None), |
| 360 | + "django": ( |
| 361 | + "http://docs.djangoproject.com/en/stable/", |
| 362 | + "http://docs.djangoproject.com/en/stable/_objects/", |
| 363 | + ), |
| 364 | + "flask": ("http://flask.pocoo.org/docs/", None), |
| 365 | + "redis-py": ("https://redis-py.readthedocs.io/en/latest/", None), |
| 366 | + "flask-sqlalchemy": ("https://flask-sqlalchemy.readthedocs.io/en/2.x/", None), |
| 367 | + "python": ("https://docs.python.org/", None), |
| 368 | + "whitenoise": ("https://whitenoise.readthedocs.io/en/stable/", None), |
| 369 | + "sanic": ("https://sanic.readthedocs.io/en/stable/", None), |
361 | 370 | }
|
0 commit comments