|
12 | 12 | # |
13 | 13 | # All configuration values have a default; values that are commented out |
14 | 14 | # serve to show the default. |
15 | | - |
| 15 | +import spade |
16 | 16 | import sys |
17 | 17 | import os |
18 | 18 |
|
|
31 | 31 | # version is used. |
32 | 32 | sys.path.insert(0, project_root) |
33 | 33 |
|
34 | | -import spade |
35 | 34 |
|
36 | 35 | # -- General configuration --------------------------------------------- |
37 | 36 |
|
|
40 | 39 |
|
41 | 40 | # Add any Sphinx extension module names here, as strings. They can be |
42 | 41 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
43 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.autosectionlabel'] |
| 42 | +extensions = [ |
| 43 | + "sphinx.ext.autodoc", |
| 44 | + "sphinx.ext.viewcode", |
| 45 | + "sphinx.ext.autosectionlabel", |
| 46 | +] |
44 | 47 |
|
45 | 48 | # Add any paths that contain templates here, relative to this directory. |
46 | | -templates_path = ['_templates'] |
| 49 | +templates_path = ["_templates"] |
47 | 50 |
|
48 | 51 | # The suffix of source filenames. |
49 | | -source_suffix = '.rst' |
| 52 | +source_suffix = ".rst" |
50 | 53 |
|
51 | 54 | # The encoding of source files. |
52 | 55 | # source_encoding = 'utf-8-sig' |
53 | 56 |
|
54 | 57 | # The master toctree document. |
55 | | -master_doc = 'index' |
| 58 | +master_doc = "index" |
56 | 59 |
|
57 | 60 | # General information about the project. |
58 | | -project = u'SPADE' |
59 | | -copyright = u"2020, Javi Palanca" |
| 61 | +project = "SPADE" |
| 62 | +copyright = "2020, Javi Palanca" |
60 | 63 |
|
61 | 64 | # The version info for the project you're documenting, acts as replacement |
62 | 65 | # for |version| and |release|, also used in various other places throughout |
|
79 | 82 |
|
80 | 83 | # List of patterns, relative to source directory, that match files and |
81 | 84 | # directories to ignore when looking for source files. |
82 | | -exclude_patterns = ['_build'] |
| 85 | +exclude_patterns = ["_build"] |
83 | 86 |
|
84 | 87 | # The reST default role (used for this markup: `text`) to use for all |
85 | 88 | # documents. |
|
97 | 100 | # show_authors = False |
98 | 101 |
|
99 | 102 | # The name of the Pygments (syntax highlighting) style to use. |
100 | | -pygments_style = 'sphinx' |
| 103 | +pygments_style = "sphinx" |
101 | 104 |
|
102 | 105 | # A list of ignored prefixes for module index sorting. |
103 | 106 | # modindex_common_prefix = [] |
|
111 | 114 |
|
112 | 115 | # The theme to use for HTML and HTML Help pages. See the documentation for |
113 | 116 | # a list of builtin themes. |
114 | | -html_theme = 'sphinx_rtd_theme' |
| 117 | +html_theme = "sphinx_rtd_theme" |
115 | 118 |
|
116 | 119 | # Theme options are theme-specific and customize the look and feel of a |
117 | 120 | # theme further. For a list of options available for each theme, see the |
|
142 | 145 | # here, relative to this directory. They are copied after the builtin |
143 | 146 | # static files, so a file named "default.css" will overwrite the builtin |
144 | 147 | # "default.css". |
145 | | -html_static_path = ['_static'] |
| 148 | +html_static_path = ["_static"] |
146 | 149 |
|
147 | 150 | # If not '', a 'Last updated on:' timestamp is inserted at every page |
148 | 151 | # bottom, using the given strftime format. |
|
188 | 191 | # html_file_suffix = None |
189 | 192 |
|
190 | 193 | # Output file base name for HTML help builder. |
191 | | -htmlhelp_basename = 'spadedoc' |
| 194 | +htmlhelp_basename = "spadedoc" |
192 | 195 |
|
193 | 196 | # -- Options for LaTeX output ------------------------------------------ |
194 | 197 |
|
195 | 198 | latex_elements = { |
196 | 199 | # The paper size ('letterpaper' or 'a4paper'). |
197 | 200 | # 'papersize': 'letterpaper', |
198 | | - |
199 | 201 | # The font size ('10pt', '11pt' or '12pt'). |
200 | 202 | # 'pointsize': '10pt', |
201 | | - |
202 | 203 | # Additional stuff for the LaTeX preamble. |
203 | 204 | # 'preamble': '', |
204 | 205 | } |
|
207 | 208 | # (source start file, target name, title, author, documentclass |
208 | 209 | # [howto/manual]). |
209 | 210 | latex_documents = [ |
210 | | - ('index', 'spade.tex', |
211 | | - u'SPADE Documentation', |
212 | | - u'Javi Palanca', 'manual'), |
| 211 | + ("index", "spade.tex", "SPADE Documentation", "Javi Palanca", "manual"), |
213 | 212 | ] |
214 | 213 |
|
215 | 214 | # The name of an image file (relative to this directory) to place at |
|
237 | 236 |
|
238 | 237 | # One entry per manual page. List of tuples |
239 | 238 | # (source start file, name, description, authors, manual section). |
240 | | -man_pages = [ |
241 | | - ('index', 'spade', |
242 | | - u'SPADE Documentation', |
243 | | - [u'Javi Palanca'], 1) |
244 | | -] |
| 239 | +man_pages = [("index", "spade", "SPADE Documentation", ["Javi Palanca"], 1)] |
245 | 240 |
|
246 | 241 | # If true, show URL addresses after external links. |
247 | 242 | # man_show_urls = False |
|
253 | 248 | # (source start file, target name, title, author, |
254 | 249 | # dir menu entry, description, category) |
255 | 250 | texinfo_documents = [ |
256 | | - ('index', 'spade', |
257 | | - u'SPADE Documentation', |
258 | | - u'Javi Palanca', |
259 | | - 'spade', |
260 | | - 'Smart Python multi-Agent Development Environment.', |
261 | | - 'Artificial Intelligence'), |
| 251 | + ( |
| 252 | + "index", |
| 253 | + "spade", |
| 254 | + "SPADE Documentation", |
| 255 | + "Javi Palanca", |
| 256 | + "spade", |
| 257 | + "Smart Python multi-Agent Development Environment.", |
| 258 | + "Artificial Intelligence", |
| 259 | + ), |
262 | 260 | ] |
263 | 261 |
|
264 | 262 | # Documents to append as an appendix to all manuals. |
|
0 commit comments