|
11 | 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
12 | 12 | # |
13 | 13 | from packaging.version import Version |
14 | | -from templateflow import __version__, __copyright__, __packagename__ |
| 14 | + |
| 15 | +from templateflow import __copyright__, __packagename__, __version__ |
15 | 16 |
|
16 | 17 | # -- Project information ----------------------------------------------------- |
17 | 18 | project = __packagename__ |
18 | 19 | copyright = __copyright__ |
19 | | -author = "The NiPreps Developers" |
| 20 | +author = 'The NiPreps Developers' |
20 | 21 |
|
21 | 22 | # The full version, including alpha/beta/rc tags |
22 | 23 | release = __version__ |
|
29 | 30 |
|
30 | 31 | # -- General configuration --------------------------------------------------- |
31 | 32 | extensions = [ |
32 | | - "sphinx.ext.autodoc", |
33 | | - "sphinx.ext.coverage", |
34 | | - "sphinx.ext.doctest", |
35 | | - "sphinx.ext.githubpages", |
36 | | - "sphinx.ext.ifconfig", |
37 | | - "sphinx.ext.intersphinx", |
38 | | - "sphinx.ext.mathjax", |
39 | | - "sphinx.ext.napoleon", |
40 | | - "sphinx.ext.viewcode", |
41 | | - "sphinxcontrib.apidoc", |
42 | | - "nbsphinx", |
43 | | - "sphinx_click", |
| 33 | + 'sphinx.ext.autodoc', |
| 34 | + 'sphinx.ext.coverage', |
| 35 | + 'sphinx.ext.doctest', |
| 36 | + 'sphinx.ext.githubpages', |
| 37 | + 'sphinx.ext.ifconfig', |
| 38 | + 'sphinx.ext.intersphinx', |
| 39 | + 'sphinx.ext.mathjax', |
| 40 | + 'sphinx.ext.napoleon', |
| 41 | + 'sphinx.ext.viewcode', |
| 42 | + 'sphinxcontrib.apidoc', |
| 43 | + 'nbsphinx', |
| 44 | + 'sphinx_click', |
44 | 45 | ] |
45 | 46 |
|
46 | 47 | autodoc_mock_imports = [ |
47 | | - "matplotlib", |
48 | | - "nilearn", |
49 | | - "nipy", |
50 | | - "nitime", |
51 | | - "numpy", |
52 | | - "pandas", |
53 | | - "seaborn", |
54 | | - "skimage", |
55 | | - "svgutils", |
56 | | - "transforms3d", |
| 48 | + 'matplotlib', |
| 49 | + 'nilearn', |
| 50 | + 'nipy', |
| 51 | + 'nitime', |
| 52 | + 'numpy', |
| 53 | + 'pandas', |
| 54 | + 'seaborn', |
| 55 | + 'skimage', |
| 56 | + 'svgutils', |
| 57 | + 'transforms3d', |
57 | 58 | ] |
58 | 59 | autodoc_autoreload = True |
59 | 60 |
|
|
68 | 69 | # ] |
69 | 70 |
|
70 | 71 | # Add any paths that contain templates here, relative to this directory. |
71 | | -templates_path = ["_templates"] |
| 72 | +templates_path = ['_templates'] |
72 | 73 |
|
73 | 74 | # The suffix(es) of source filenames. |
74 | 75 | # You can specify multiple suffix as a list of string: |
75 | 76 | # |
76 | 77 | # source_suffix = ['.rst', '.md'] |
77 | | -source_suffix = ".rst" |
| 78 | +source_suffix = '.rst' |
78 | 79 |
|
79 | 80 | # The master toctree document. |
80 | | -master_doc = "index" |
| 81 | +master_doc = 'index' |
81 | 82 |
|
82 | 83 | # The language for content autogenerated by Sphinx. Refer to documentation |
83 | 84 | # for a list of supported languages. |
|
90 | 91 | # directories to ignore when looking for source files. |
91 | 92 | # This pattern also affects html_static_path and html_extra_path. |
92 | 93 | exclude_patterns = [ |
93 | | - "_build", |
94 | | - "Thumbs.db", |
95 | | - ".DS_Store", |
96 | | - "api/modules.rst", |
97 | | - "api/templateflow.rst", |
| 94 | + '_build', |
| 95 | + 'Thumbs.db', |
| 96 | + '.DS_Store', |
| 97 | + 'api/modules.rst', |
| 98 | + 'api/templateflow.rst', |
98 | 99 | ] |
99 | 100 |
|
100 | 101 | # The name of the Pygments (syntax highlighting) style to use. |
|
106 | 107 | # The theme to use for HTML and HTML Help pages. See the documentation for |
107 | 108 | # a list of builtin themes. |
108 | 109 | # |
109 | | -html_theme = "sphinx_rtd_theme" |
| 110 | +html_theme = 'sphinx_rtd_theme' |
110 | 111 |
|
111 | 112 | # Theme options are theme-specific and customize the look and feel of a theme |
112 | 113 | # further. For a list of options available for each theme, see the |
|
117 | 118 | # Add any paths that contain custom static files (such as style sheets) here, |
118 | 119 | # relative to this directory. They are copied after the builtin static files, |
119 | 120 | # so a file named "default.css" will overwrite the builtin "default.css". |
120 | | -html_static_path = ["_static"] |
| 121 | +html_static_path = ['_static'] |
121 | 122 |
|
122 | 123 | # Custom sidebar templates, must be a dictionary that maps document names |
123 | 124 | # to template names. |
|
133 | 134 | # -- Options for HTMLHelp output --------------------------------------------- |
134 | 135 |
|
135 | 136 | # Output file base name for HTML help builder. |
136 | | -htmlhelp_basename = "templateflowdoc" |
| 137 | +htmlhelp_basename = 'templateflowdoc' |
137 | 138 |
|
138 | 139 |
|
139 | 140 | # -- Options for LaTeX output ------------------------------------------------ |
|
159 | 160 | latex_documents = [ |
160 | 161 | ( |
161 | 162 | master_doc, |
162 | | - "templateflow.tex", |
163 | | - "TemplateFlow Documentation", |
164 | | - "The TemplateFlow Developers", |
165 | | - "manual", |
| 163 | + 'templateflow.tex', |
| 164 | + 'TemplateFlow Documentation', |
| 165 | + 'The TemplateFlow Developers', |
| 166 | + 'manual', |
166 | 167 | ), |
167 | 168 | ] |
168 | 169 |
|
|
171 | 172 |
|
172 | 173 | # One entry per manual page. List of tuples |
173 | 174 | # (source start file, name, description, authors, manual section). |
174 | | -man_pages = [(master_doc, "templateflow", "TemplateFlow Documentation", [author], 1)] |
| 175 | +man_pages = [(master_doc, 'templateflow', 'TemplateFlow Documentation', [author], 1)] |
175 | 176 |
|
176 | 177 |
|
177 | 178 | # -- Options for Texinfo output ---------------------------------------------- |
|
182 | 183 | texinfo_documents = [ |
183 | 184 | ( |
184 | 185 | master_doc, |
185 | | - "templateflow", |
186 | | - "TemplateFlow Documentation", |
| 186 | + 'templateflow', |
| 187 | + 'TemplateFlow Documentation', |
187 | 188 | author, |
188 | | - "TemplateFlow", |
189 | | - "One line description of project.", |
190 | | - "Miscellaneous", |
| 189 | + 'TemplateFlow', |
| 190 | + 'One line description of project.', |
| 191 | + 'Miscellaneous', |
191 | 192 | ), |
192 | 193 | ] |
193 | 194 |
|
|
207 | 208 | # epub_uid = '' |
208 | 209 |
|
209 | 210 | # A list of files that should not be packed into the epub file. |
210 | | -epub_exclude_files = ["search.html"] |
| 211 | +epub_exclude_files = ['search.html'] |
211 | 212 |
|
212 | 213 |
|
213 | 214 | # -- Extension configuration ------------------------------------------------- |
214 | 215 |
|
215 | | -apidoc_module_dir = "../templateflow" |
216 | | -apidoc_output_dir = "api" |
| 216 | +apidoc_module_dir = '../templateflow' |
| 217 | +apidoc_output_dir = 'api' |
217 | 218 | apidoc_excluded_paths = [ |
218 | | - "conftest.py", |
219 | | - "*/tests/*", |
220 | | - "tests/*", |
221 | | - "data/*", |
| 219 | + 'conftest.py', |
| 220 | + '*/tests/*', |
| 221 | + 'tests/*', |
| 222 | + 'data/*', |
222 | 223 | ] |
223 | 224 | apidoc_separate_modules = True |
224 | | -apidoc_extra_args = ["--module-first", "-d 1", "-T"] |
| 225 | +apidoc_extra_args = ['--module-first', '-d 1', '-T'] |
225 | 226 |
|
226 | 227 | # -- Options for intersphinx extension --------------------------------------- |
227 | 228 |
|
228 | 229 | # Example configuration for intersphinx: refer to the Python standard library. |
229 | 230 | intersphinx_mapping = { |
230 | | - "bids": ("https://bids-standard.github.io/pybids/", None), |
231 | | - "matplotlib": ("https://matplotlib.org/", None), |
232 | | - "nibabel": ("https://nipy.org/nibabel/", None), |
233 | | - "nipype": ("https://nipype.readthedocs.io/en/latest/", None), |
234 | | - "numpy": ("https://numpy.org/doc/stable/", None), |
235 | | - "pandas": ("http://pandas.pydata.org/pandas-docs/dev", None), |
236 | | - "python": ("https://docs.python.org/3/", None), |
237 | | - "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), |
| 231 | + 'bids': ('https://bids-standard.github.io/pybids/', None), |
| 232 | + 'matplotlib': ('https://matplotlib.org/', None), |
| 233 | + 'nibabel': ('https://nipy.org/nibabel/', None), |
| 234 | + 'nipype': ('https://nipype.readthedocs.io/en/latest/', None), |
| 235 | + 'numpy': ('https://numpy.org/doc/stable/', None), |
| 236 | + 'pandas': ('http://pandas.pydata.org/pandas-docs/dev', None), |
| 237 | + 'python': ('https://docs.python.org/3/', None), |
| 238 | + 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None), |
238 | 239 | } |
239 | 240 |
|
240 | 241 | # -- Options for versioning extension ---------------------------------------- |
241 | | -smv_branch_whitelist = r"^master$" |
242 | | -smv_tag_whitelist = r"^\d+\.\d+\.\d+(?!rc|dev).*$" |
| 242 | +smv_branch_whitelist = r'^master$' |
| 243 | +smv_tag_whitelist = r'^\d+\.\d+\.\d+(?!rc|dev).*$' |
243 | 244 | smv_released_pattern = r'^tags/.*$' |
244 | 245 | smv_rebuild_tags = False |
0 commit comments