|
21 | 21 | # Prevent etelemetry from loading at all |
22 | 22 | # Could set NO_ET environment variable, but why? |
23 | 23 | MOCKS = [ |
24 | | - "etelemetry", |
25 | | - "matplotlib", |
26 | | - "matplotlib.pyplot", |
27 | | - "matplotlib.cm", |
28 | | - "matplotlib.colors", |
29 | | - "matplotlib.colorbar", |
| 24 | + 'etelemetry', |
| 25 | + 'matplotlib', |
| 26 | + 'matplotlib.pyplot', |
| 27 | + 'matplotlib.cm', |
| 28 | + 'matplotlib.colors', |
| 29 | + 'matplotlib.colorbar', |
30 | 30 | ] |
31 | 31 | sys.modules.update({mod: mock.Mock() for mod in MOCKS}) |
32 | 32 |
|
|
38 | 38 |
|
39 | 39 | from niworkflows import __version__, __copyright__, __packagename__ |
40 | 40 |
|
41 | | -sys.path.append(os.path.abspath("sphinxext")) |
| 41 | +sys.path.append(os.path.abspath('sphinxext')) |
42 | 42 |
|
43 | 43 | # -- Project information ----------------------------------------------------- |
44 | 44 | project = __packagename__ |
45 | 45 | copyright = __copyright__ |
46 | | -author = "The NiPreps Developers" |
| 46 | +author = 'The NiPreps Developers' |
47 | 47 |
|
48 | 48 | # The short X.Y version |
49 | 49 | version = Version(__version__).base_version |
|
53 | 53 |
|
54 | 54 | # -- General configuration --------------------------------------------------- |
55 | 55 | extensions = [ |
56 | | - "sphinx.ext.autodoc", |
57 | | - "sphinx.ext.coverage", |
58 | | - "sphinx.ext.doctest", |
59 | | - "sphinx.ext.githubpages", |
60 | | - "sphinx.ext.ifconfig", |
61 | | - "sphinx.ext.intersphinx", |
62 | | - "sphinx.ext.mathjax", |
63 | | - "sphinx.ext.viewcode", |
64 | | - "sphinxcontrib.apidoc", |
65 | | - "nipype.sphinxext.apidoc", |
66 | | - "nipype.sphinxext.plot_workflow", |
| 56 | + 'sphinx.ext.autodoc', |
| 57 | + 'sphinx.ext.coverage', |
| 58 | + 'sphinx.ext.doctest', |
| 59 | + 'sphinx.ext.githubpages', |
| 60 | + 'sphinx.ext.ifconfig', |
| 61 | + 'sphinx.ext.intersphinx', |
| 62 | + 'sphinx.ext.mathjax', |
| 63 | + 'sphinx.ext.viewcode', |
| 64 | + 'sphinxcontrib.apidoc', |
| 65 | + 'nipype.sphinxext.apidoc', |
| 66 | + 'nipype.sphinxext.plot_workflow', |
67 | 67 | ] |
68 | 68 |
|
69 | 69 | autodoc_mock_imports = [ |
70 | | - "nilearn", |
71 | | - "nitime", |
72 | | - "numpy", |
73 | | - "pandas", |
74 | | - "seaborn", |
75 | | - "skimage", |
76 | | - "svgutils", |
77 | | - "templateflow", |
78 | | - "transforms3d", |
79 | | - "yaml", |
| 70 | + 'nilearn', |
| 71 | + 'nitime', |
| 72 | + 'numpy', |
| 73 | + 'pandas', |
| 74 | + 'seaborn', |
| 75 | + 'skimage', |
| 76 | + 'svgutils', |
| 77 | + 'templateflow', |
| 78 | + 'transforms3d', |
| 79 | + 'yaml', |
80 | 80 | ] |
81 | 81 |
|
82 | 82 | # Accept custom section names to be parsed for numpy-style docstrings |
|
85 | 85 | # https://github.com/sphinx-contrib/napoleon/pull/10 is merged. |
86 | 86 | napoleon_use_param = False |
87 | 87 | napoleon_custom_sections = [ |
88 | | - ("Inputs", "Parameters"), |
89 | | - ("Outputs", "Parameters"), |
90 | | - ("Attributes", "Parameters"), |
91 | | - ("Mandatory Inputs", "Parameters"), |
92 | | - ("Optional Inputs", "Parameters"), |
| 88 | + ('Inputs', 'Parameters'), |
| 89 | + ('Outputs', 'Parameters'), |
| 90 | + ('Attributes', 'Parameters'), |
| 91 | + ('Mandatory Inputs', 'Parameters'), |
| 92 | + ('Optional Inputs', 'Parameters'), |
93 | 93 | ] |
94 | 94 |
|
95 | 95 | # Add any paths that contain templates here, relative to this directory. |
96 | | -templates_path = ["_templates"] |
| 96 | +templates_path = ['_templates'] |
97 | 97 |
|
98 | 98 | # The suffix(es) of source filenames. |
99 | 99 | # You can specify multiple suffix as a list of string: |
100 | 100 | # |
101 | 101 | # source_suffix = ['.rst', '.md'] |
102 | | -source_suffix = ".rst" |
| 102 | +source_suffix = '.rst' |
103 | 103 |
|
104 | 104 | # The master toctree document. |
105 | | -master_doc = "index" |
| 105 | +master_doc = 'index' |
106 | 106 |
|
107 | 107 | # The language for content autogenerated by Sphinx. Refer to documentation |
108 | 108 | # for a list of supported languages. |
|
115 | 115 | # directories to ignore when looking for source files. |
116 | 116 | # This pattern also affects html_static_path and html_extra_path. |
117 | 117 | exclude_patterns = [ |
118 | | - "_build", |
119 | | - "Thumbs.db", |
120 | | - ".DS_Store", |
121 | | - "api/modules.rst", |
122 | | - "api/niworkflows.rst", |
| 118 | + '_build', |
| 119 | + 'Thumbs.db', |
| 120 | + '.DS_Store', |
| 121 | + 'api/modules.rst', |
| 122 | + 'api/niworkflows.rst', |
123 | 123 | ] |
124 | 124 |
|
125 | 125 | # The name of the Pygments (syntax highlighting) style to use. |
|
131 | 131 | # The theme to use for HTML and HTML Help pages. See the documentation for |
132 | 132 | # a list of builtin themes. |
133 | 133 | # |
134 | | -html_theme = "furo" |
| 134 | +html_theme = 'furo' |
135 | 135 |
|
136 | 136 | # Theme options are theme-specific and customize the look and feel of a theme |
137 | 137 | # further. For a list of options available for each theme, see the |
|
142 | 142 | # Add any paths that contain custom static files (such as style sheets) here, |
143 | 143 | # relative to this directory. They are copied after the builtin static files, |
144 | 144 | # so a file named "default.css" will overwrite the builtin "default.css". |
145 | | -html_static_path = ["_static"] |
| 145 | +html_static_path = ['_static'] |
146 | 146 | html_js_files = [ |
147 | | - "js/version-switch.js", |
| 147 | + 'js/version-switch.js', |
148 | 148 | ] |
149 | 149 | html_css_files = [ |
150 | | - "css/version-switch.css", |
| 150 | + 'css/version-switch.css', |
151 | 151 | ] |
152 | 152 |
|
153 | 153 | # Custom sidebar templates, must be a dictionary that maps document names |
|
164 | 164 | # -- Options for HTMLHelp output --------------------------------------------- |
165 | 165 |
|
166 | 166 | # Output file base name for HTML help builder. |
167 | | -htmlhelp_basename = "niworkflowsdoc" |
| 167 | +htmlhelp_basename = 'niworkflowsdoc' |
168 | 168 |
|
169 | 169 |
|
170 | 170 | # -- Options for LaTeX output ------------------------------------------------ |
|
190 | 190 | latex_documents = [ |
191 | 191 | ( |
192 | 192 | master_doc, |
193 | | - "niworkflows.tex", |
194 | | - "NiWorkflows Documentation", |
195 | | - "The NiPreps Developers", |
196 | | - "manual", |
| 193 | + 'niworkflows.tex', |
| 194 | + 'NiWorkflows Documentation', |
| 195 | + 'The NiPreps Developers', |
| 196 | + 'manual', |
197 | 197 | ), |
198 | 198 | ] |
199 | 199 |
|
|
202 | 202 |
|
203 | 203 | # One entry per manual page. List of tuples |
204 | 204 | # (source start file, name, description, authors, manual section). |
205 | | -man_pages = [(master_doc, "niworkflows", "NiWorkflows Documentation", [author], 1)] |
| 205 | +man_pages = [(master_doc, 'niworkflows', 'NiWorkflows Documentation', [author], 1)] |
206 | 206 |
|
207 | 207 |
|
208 | 208 | # -- Options for Texinfo output ---------------------------------------------- |
|
213 | 213 | texinfo_documents = [ |
214 | 214 | ( |
215 | 215 | master_doc, |
216 | | - "niworkflows", |
217 | | - "NiWorkflows Documentation", |
| 216 | + 'niworkflows', |
| 217 | + 'NiWorkflows Documentation', |
218 | 218 | author, |
219 | | - "NiWorkflows", |
220 | | - "One line description of project.", |
221 | | - "Miscellaneous", |
| 219 | + 'NiWorkflows', |
| 220 | + 'One line description of project.', |
| 221 | + 'Miscellaneous', |
222 | 222 | ), |
223 | 223 | ] |
224 | 224 |
|
|
238 | 238 | # epub_uid = '' |
239 | 239 |
|
240 | 240 | # A list of files that should not be packed into the epub file. |
241 | | -epub_exclude_files = ["search.html"] |
| 241 | +epub_exclude_files = ['search.html'] |
242 | 242 |
|
243 | 243 |
|
244 | 244 | # -- Extension configuration ------------------------------------------------- |
245 | 245 |
|
246 | | -apidoc_module_dir = "../niworkflows" |
247 | | -apidoc_output_dir = "api" |
248 | | -apidoc_excluded_paths = ["conftest.py", "*/tests/*", "tests/*", "testing.py"] |
| 246 | +apidoc_module_dir = '../niworkflows' |
| 247 | +apidoc_output_dir = 'api' |
| 248 | +apidoc_excluded_paths = ['conftest.py', '*/tests/*', 'tests/*', 'testing.py'] |
249 | 249 | apidoc_separate_modules = True |
250 | | -apidoc_extra_args = ["--module-first", "-d 1", "-T"] |
| 250 | +apidoc_extra_args = ['--module-first', '-d 1', '-T'] |
251 | 251 |
|
252 | 252 | # -- Options for intersphinx extension --------------------------------------- |
253 | 253 |
|
254 | 254 | # Example configuration for intersphinx: refer to the Python standard library. |
255 | 255 | intersphinx_mapping = { |
256 | | - "bids": ("https://bids-standard.github.io/pybids/", None), |
257 | | - "matplotlib": ("https://matplotlib.org/stable", None), |
258 | | - "nibabel": ("https://nipy.org/nibabel/", None), |
259 | | - "nipype": ("https://nipype.readthedocs.io/en/latest/", None), |
260 | | - "numpy": ("https://numpy.org/doc/stable/", None), |
261 | | - "pandas": ("https://pandas.pydata.org/pandas-docs/dev", None), |
262 | | - "python": ("https://docs.python.org/3/", None), |
263 | | - "scipy": ("https://docs.scipy.org/doc/scipy/", None), |
264 | | - "smriprep": ("https://www.nipreps.org/smriprep/", None), |
265 | | - "surfplot": ("https://surfplot.readthedocs.io/en/latest/", None), |
266 | | - "templateflow": ("https://www.templateflow.org/python-client", None), |
| 256 | + 'bids': ('https://bids-standard.github.io/pybids/', None), |
| 257 | + 'matplotlib': ('https://matplotlib.org/stable', None), |
| 258 | + 'nibabel': ('https://nipy.org/nibabel/', None), |
| 259 | + 'nipype': ('https://nipype.readthedocs.io/en/latest/', None), |
| 260 | + 'numpy': ('https://numpy.org/doc/stable/', None), |
| 261 | + 'pandas': ('https://pandas.pydata.org/pandas-docs/dev', None), |
| 262 | + 'python': ('https://docs.python.org/3/', None), |
| 263 | + 'scipy': ('https://docs.scipy.org/doc/scipy/', None), |
| 264 | + 'smriprep': ('https://www.nipreps.org/smriprep/', None), |
| 265 | + 'surfplot': ('https://surfplot.readthedocs.io/en/latest/', None), |
| 266 | + 'templateflow': ('https://www.templateflow.org/python-client', None), |
267 | 267 | } |
268 | 268 |
|
269 | 269 | # -- Options for versioning extension ---------------------------------------- |
|
0 commit comments