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