|
20 | 20 | import os |
21 | 21 | import sys |
22 | 22 |
|
23 | | -sys.path.insert(0, os.path.abspath('..')) |
| 23 | +sys.path.insert(0, os.path.abspath("..")) |
24 | 24 |
|
25 | 25 | import ecs_files_composer |
26 | 26 |
|
|
32 | 32 |
|
33 | 33 | # Add any Sphinx extension module names here, as strings. They can be |
34 | 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
35 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
| 35 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] |
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(es) of source filenames. |
41 | 41 | # You can specify multiple suffix as a list of string: |
42 | 42 | # |
43 | 43 | # source_suffix = ['.rst', '.md'] |
44 | | -source_suffix = '.rst' |
| 44 | +source_suffix = ".rst" |
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 = 'ECS Files Composer' |
| 50 | +project = "ECS Files Composer" |
51 | 51 | copyright = "2021, John Preston" |
52 | 52 | author = "John Preston" |
53 | 53 |
|
|
70 | 70 | # List of patterns, relative to source directory, that match files and |
71 | 71 | # directories to ignore when looking for source files. |
72 | 72 | # This patterns also effect to html_static_path and html_extra_path |
73 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 73 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
74 | 74 |
|
75 | 75 | # The name of the Pygments (syntax highlighting) style to use. |
76 | | -pygments_style = 'sphinx' |
| 76 | +pygments_style = "sphinx" |
77 | 77 |
|
78 | 78 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
79 | 79 | todo_include_todos = False |
|
137 | 137 | # Add any paths that contain custom static files (such as style sheets) here, |
138 | 138 | # relative to this directory. They are copied after the builtin static files, |
139 | 139 | # so a file named "default.css" will overwrite the builtin "default.css". |
140 | | -html_static_path = ['_static'] |
| 140 | +html_static_path = ["_static"] |
141 | 141 | html_show_sourcelink = True |
142 | | -html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]} |
| 142 | +html_sidebars = { |
| 143 | + "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"] |
| 144 | +} |
143 | 145 |
|
144 | 146 | # -- Options for HTMLHelp output --------------------------------------- |
145 | 147 |
|
146 | 148 | # Output file base name for HTML help builder. |
147 | | -htmlhelp_basename = 'ecs_files_composerdoc' |
| 149 | +htmlhelp_basename = "ecs_files_composerdoc" |
148 | 150 |
|
149 | 151 |
|
150 | 152 | # -- Options for LaTeX output ------------------------------------------ |
|
168 | 170 | # (source start file, target name, title, author, documentclass |
169 | 171 | # [howto, manual, or own class]). |
170 | 172 | latex_documents = [ |
171 | | - (master_doc, 'ecs_files_composer.tex', 'ECS Files Composer Documentation', 'John Preston', 'manual'), |
| 173 | + ( |
| 174 | + master_doc, |
| 175 | + "ecs_files_composer.tex", |
| 176 | + "ECS Files Composer Documentation", |
| 177 | + "John Preston", |
| 178 | + "manual", |
| 179 | + ), |
172 | 180 | ] |
173 | 181 |
|
174 | 182 | # -- Options for manual page output ------------------------------------ |
175 | 183 |
|
176 | 184 | # One entry per manual page. List of tuples |
177 | 185 | # (source start file, name, description, authors, manual section). |
178 | | -man_pages = [(master_doc, 'ecs_files_composer', 'ECS Files Composer Documentation', [author], 1)] |
| 186 | +man_pages = [ |
| 187 | + (master_doc, "ecs_files_composer", "ECS Files Composer Documentation", [author], 1) |
| 188 | +] |
179 | 189 |
|
180 | 190 | # -- Options for Texinfo output ---------------------------------------- |
181 | 191 |
|
|
185 | 195 | texinfo_documents = [ |
186 | 196 | ( |
187 | 197 | master_doc, |
188 | | - 'ecs_files_composer', |
189 | | - 'ECS Files Composer Documentation', |
| 198 | + "ecs_files_composer", |
| 199 | + "ECS Files Composer Documentation", |
190 | 200 | author, |
191 | | - 'ecs_files_composer', |
192 | | - 'One line description of project.', |
193 | | - 'Miscellaneous', |
| 201 | + "ecs_files_composer", |
| 202 | + "One line description of project.", |
| 203 | + "Miscellaneous", |
194 | 204 | ), |
195 | 205 | ] |
0 commit comments