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