|
12 | 12 | # All configuration values have a default; values that are commented out |
13 | 13 | # serve to show the default. |
14 | 14 |
|
| 15 | +import sys |
| 16 | + |
15 | 17 | # If extensions (or modules to document with autodoc) are in another directory, |
16 | 18 | # add these directories to sys.path here. If the directory is relative to the |
17 | 19 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
18 | 20 | # |
19 | 21 | from os import path |
20 | | -import sys |
21 | 22 |
|
22 | 23 | sys.path.insert(0, path.dirname(path.dirname(__file__))) |
23 | 24 |
|
24 | 25 |
|
25 | | -import sphinx_rtd_theme |
| 26 | +import sphinx_rtd_theme # noqa: E402 |
26 | 27 |
|
27 | 28 | html_theme = "sphinx_rtd_theme" |
28 | 29 |
|
|
38 | 39 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
39 | 40 | # ones. |
40 | 41 | extensions = [ |
41 | | - 'sphinx.ext.autosectionlabel', |
| 42 | + "sphinx.ext.autosectionlabel", |
42 | 43 | ] |
43 | 44 |
|
44 | 45 | # Add any paths that contain templates here, relative to this directory. |
45 | | -templates_path = ['_templates'] |
| 46 | +templates_path = ["_templates"] |
46 | 47 |
|
47 | 48 | # The suffix(es) of source filenames. |
48 | 49 | # You can specify multiple suffix as a list of string: |
49 | 50 | # |
50 | 51 | # source_suffix = ['.rst', '.md'] |
51 | | -source_suffix = '.rst' |
| 52 | +source_suffix = ".rst" |
52 | 53 |
|
53 | 54 | # The master toctree document. |
54 | | -master_doc = 'index' |
| 55 | +master_doc = "index" |
55 | 56 |
|
56 | 57 | # General information about the project. |
57 | | -project = u'scrapy-zyte-smartproxy' |
58 | | -copyright = u'2011-2021, Zyte Group Ltd' |
59 | | -author = u'Zyte' |
| 58 | +project = "scrapy-zyte-smartproxy" |
| 59 | +copyright = "2011-2021, Zyte Group Ltd" |
| 60 | +author = "Zyte" |
60 | 61 |
|
61 | 62 | # The version info for the project you're documenting, acts as replacement for |
62 | 63 | # |version| and |release|, also used in various other places throughout the |
|
65 | 66 |
|
66 | 67 | try: |
67 | 68 | import scrapy_zyte_smartproxy |
68 | | - version = '.'.join(scrapy_zyte_smartproxy.__version__.split('.')[:2]) |
| 69 | + |
| 70 | + version = ".".join(scrapy_zyte_smartproxy.__version__.split(".")[:2]) |
69 | 71 | release = scrapy_zyte_smartproxy.__version__ |
70 | 72 | except ImportError: |
71 | | - version = '' |
72 | | - release = '' |
| 73 | + version = "" |
| 74 | + release = "" |
73 | 75 |
|
74 | 76 | # List of patterns, relative to source directory, that match files and |
75 | 77 | # directories to ignore when looking for source files. |
76 | 78 | # This patterns also effect to html_static_path and html_extra_path |
77 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 79 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
78 | 80 |
|
79 | 81 | # The name of the Pygments (syntax highlighting) style to use. |
80 | | -pygments_style = 'sphinx' |
| 82 | +pygments_style = "sphinx" |
81 | 83 |
|
82 | 84 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
83 | 85 | todo_include_todos = False |
|
98 | 100 | # Add any paths that contain custom static files (such as style sheets) here, |
99 | 101 | # relative to this directory. They are copied after the builtin static files, |
100 | 102 | # so a file named "default.css" will overwrite the builtin "default.css". |
101 | | -#html_static_path = ['_static'] |
| 103 | +# html_static_path = ['_static'] |
102 | 104 |
|
103 | 105 |
|
104 | 106 | # -- Options for HTMLHelp output ------------------------------------------ |
105 | 107 |
|
106 | 108 | # Output file base name for HTML help builder. |
107 | | -htmlhelp_basename = 'scrapy-zyte-smartproxydoc' |
| 109 | +htmlhelp_basename = "scrapy-zyte-smartproxydoc" |
108 | 110 |
|
109 | 111 |
|
110 | 112 | # -- Options for LaTeX output --------------------------------------------- |
|
113 | 115 | # The paper size ('letterpaper' or 'a4paper'). |
114 | 116 | # |
115 | 117 | # 'papersize': 'letterpaper', |
116 | | - |
117 | 118 | # The font size ('10pt', '11pt' or '12pt'). |
118 | 119 | # |
119 | 120 | # 'pointsize': '10pt', |
120 | | - |
121 | 121 | # Additional stuff for the LaTeX preamble. |
122 | 122 | # |
123 | 123 | # 'preamble': '', |
124 | | - |
125 | 124 | # Latex figure (float) alignment |
126 | 125 | # |
127 | 126 | # 'figure_align': 'htbp', |
|
133 | 132 | latex_documents = [ |
134 | 133 | ( |
135 | 134 | master_doc, |
136 | | - 'scrapy-zyte-smartproxy.tex', |
137 | | - u'scrapy-zyte-smartproxy Documentation', |
138 | | - u'Zyte', |
139 | | - 'manual', |
| 135 | + "scrapy-zyte-smartproxy.tex", |
| 136 | + "scrapy-zyte-smartproxy Documentation", |
| 137 | + "Zyte", |
| 138 | + "manual", |
140 | 139 | ), |
141 | 140 | ] |
142 | 141 |
|
|
146 | 145 | # One entry per manual page. List of tuples |
147 | 146 | # (source start file, name, description, authors, manual section). |
148 | 147 | man_pages = [ |
149 | | - (master_doc, 'scrapy-zyte-smartproxy', u'scrapy-zyte-smartproxy Documentation', |
150 | | - [author], 1) |
| 148 | + ( |
| 149 | + master_doc, |
| 150 | + "scrapy-zyte-smartproxy", |
| 151 | + "scrapy-zyte-smartproxy Documentation", |
| 152 | + [author], |
| 153 | + 1, |
| 154 | + ) |
151 | 155 | ] |
152 | 156 |
|
153 | 157 |
|
|
157 | 161 | # (source start file, target name, title, author, |
158 | 162 | # dir menu entry, description, category) |
159 | 163 | texinfo_documents = [ |
160 | | - (master_doc, 'scrapy-zyte-smartproxy', u'scrapy-zyte-smartproxy Documentation', |
161 | | - author, 'scrapy-zyte-smartproxy', 'One line description of project.', |
162 | | - 'Miscellaneous'), |
| 164 | + ( |
| 165 | + master_doc, |
| 166 | + "scrapy-zyte-smartproxy", |
| 167 | + "scrapy-zyte-smartproxy Documentation", |
| 168 | + author, |
| 169 | + "scrapy-zyte-smartproxy", |
| 170 | + "One line description of project.", |
| 171 | + "Miscellaneous", |
| 172 | + ), |
163 | 173 | ] |
164 | | - |
165 | | - |
166 | | - |
|
0 commit comments