|
15 | 15 | # |
16 | 16 | import os |
17 | 17 | import sys |
18 | | -sys.path.insert(0, os.path.abspath('../..')) |
| 18 | + |
| 19 | +sys.path.insert(0, os.path.abspath("../..")) |
19 | 20 |
|
20 | 21 |
|
21 | 22 | # -- Project information ----------------------------------------------------- |
22 | 23 |
|
23 | | -project = 'pyglotaran' |
24 | | -copyright = u"2018, Joern Weissenborn, " \ |
25 | | - u"Joris Snellenburg, " \ |
26 | | - u"Ivo van Stokkum" |
27 | | -author = u"Joern Weissenborn, " \ |
28 | | - u"Joris Snellenburg, " \ |
29 | | - u"Ivo van Stokkum" |
| 24 | +project = "pyglotaran" |
| 25 | +copyright = "2018, Joern Weissenborn, " "Joris Snellenburg, " "Ivo van Stokkum" |
| 26 | +author = "Joern Weissenborn, " "Joris Snellenburg, " "Ivo van Stokkum" |
30 | 27 |
|
31 | 28 | # The version info for the project you're documenting, acts as replacement |
32 | 29 | # for |version| and |release|, also used in various other places throughout |
|
48 | 45 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
49 | 46 | # ones. |
50 | 47 | extensions = [ |
51 | | - 'sphinx.ext.autodoc', |
52 | | - 'sphinx.ext.autosummary', |
53 | | - 'sphinx.ext.doctest', |
54 | | - 'sphinx.ext.intersphinx', |
55 | | - 'sphinx.ext.extlinks', |
56 | | - 'sphinx.ext.imgmath', |
57 | | - 'sphinx.ext.viewcode', |
58 | | - 'sphinx.ext.napoleon', |
59 | | - 'numpydoc', |
60 | | - 'IPython.sphinxext.ipython_directive', |
61 | | - 'IPython.sphinxext.ipython_console_highlighting', |
62 | | - 'sphinx_copybutton', |
| 48 | + "sphinx.ext.autodoc", |
| 49 | + "sphinx.ext.autosummary", |
| 50 | + "sphinx.ext.doctest", |
| 51 | + "sphinx.ext.intersphinx", |
| 52 | + "sphinx.ext.extlinks", |
| 53 | + "sphinx.ext.imgmath", |
| 54 | + "sphinx.ext.viewcode", |
| 55 | + "sphinx.ext.napoleon", |
| 56 | + "numpydoc", |
| 57 | + "IPython.sphinxext.ipython_directive", |
| 58 | + "IPython.sphinxext.ipython_console_highlighting", |
| 59 | + "sphinx_copybutton", |
63 | 60 | ] |
64 | 61 |
|
65 | 62 | autoclass_content = "both" |
|
72 | 69 | napoleon_use_ivar = True |
73 | 70 |
|
74 | 71 | # Add any paths that contain templates here, relative to this directory. |
75 | | -templates_path = ['_templates'] |
| 72 | +templates_path = ["_templates"] |
76 | 73 |
|
77 | 74 | # The suffix(es) of source filenames. |
78 | 75 | # You can specify multiple suffix as a list of string: |
79 | 76 | # |
80 | 77 | # source_suffix = ['.rst', '.md'] |
81 | | -source_suffix = '.rst' |
| 78 | +source_suffix = ".rst" |
82 | 79 |
|
83 | 80 | # The master toctree document. |
84 | | -master_doc = 'index' |
| 81 | +master_doc = "index" |
85 | 82 |
|
86 | | -imgmath_image_format = 'svg' |
| 83 | +imgmath_image_format = "svg" |
87 | 84 |
|
88 | 85 | # The language for content autogenerated by Sphinx. Refer to documentation |
89 | 86 | # for a list of supported languages. |
|
98 | 95 | exclude_patterns = [] |
99 | 96 |
|
100 | 97 | # The name of the Pygments (syntax highlighting) style to use. |
101 | | -pygments_style = 'sphinx' |
| 98 | +pygments_style = "sphinx" |
102 | 99 |
|
103 | 100 |
|
104 | 101 | # -- Options for HTML output ------------------------------------------------- |
105 | 102 |
|
106 | 103 | # The theme to use for HTML and HTML Help pages. See the documentation for |
107 | 104 | # a list of builtin themes. |
108 | 105 | # |
109 | | -html_theme = 'sphinx_rtd_theme' |
| 106 | +html_theme = "sphinx_rtd_theme" |
110 | 107 | html_theme_options = { |
111 | | - 'navigation_depth': -1, |
| 108 | + "navigation_depth": -1, |
112 | 109 | } |
113 | 110 | html_favicon = "images/glotaran_favicon.png" |
114 | 111 | html_logo = "images/glotaran.png" |
|
140 | 137 | # -- Options for HTMLHelp output --------------------------------------------- |
141 | 138 |
|
142 | 139 | # Output file base name for HTML help builder. |
143 | | -htmlhelp_basename = 'pyglotarandoc' |
| 140 | +htmlhelp_basename = "pyglotarandoc" |
144 | 141 |
|
145 | 142 |
|
146 | 143 | # -- Options for LaTeX output ------------------------------------------------ |
|
149 | 146 | # The paper size ('letterpaper' or 'a4paper'). |
150 | 147 | # |
151 | 148 | # 'papersize': 'letterpaper', |
152 | | - |
153 | 149 | # The font size ('10pt', '11pt' or '12pt'). |
154 | 150 | # |
155 | 151 | # 'pointsize': '10pt', |
156 | | - |
157 | 152 | # Additional stuff for the LaTeX preamble. |
158 | 153 | # |
159 | 154 | # 'preamble': '', |
160 | | - |
161 | 155 | # Latex figure (float) alignment |
162 | 156 | # |
163 | 157 | # 'figure_align': 'htbp', |
|
167 | 161 | # (source start file, target name, title, |
168 | 162 | # author, documentclass [howto, manual, or own class]). |
169 | 163 | latex_documents = [ |
170 | | - (master_doc, 'pyglotaran.tex', 'pyglotaran Documentation', |
171 | | - u'Joris Snellenburg, ' |
172 | | - u'Joern Weissenborn, ' |
173 | | - u'Ivo van Stokkum', |
174 | | - 'manual'), |
| 164 | + ( |
| 165 | + master_doc, |
| 166 | + "pyglotaran.tex", |
| 167 | + "pyglotaran Documentation", |
| 168 | + "Joris Snellenburg, " "Joern Weissenborn, " "Ivo van Stokkum", |
| 169 | + "manual", |
| 170 | + ), |
175 | 171 | ] |
176 | 172 |
|
177 | 173 |
|
178 | 174 | # -- Options for manual page output ------------------------------------------ |
179 | 175 |
|
180 | 176 | # One entry per manual page. List of tuples |
181 | 177 | # (source start file, name, description, authors, manual section). |
182 | | -man_pages = [ |
183 | | - (master_doc, 'pyglotaran', 'pyglotaran Documentation', |
184 | | - [author], 1) |
185 | | -] |
| 178 | +man_pages = [(master_doc, "pyglotaran", "pyglotaran Documentation", [author], 1)] |
186 | 179 |
|
187 | 180 |
|
188 | 181 | # -- Options for Texinfo output ---------------------------------------------- |
|
191 | 184 | # (source start file, target name, title, author, |
192 | 185 | # dir menu entry, description, category) |
193 | 186 | texinfo_documents = [ |
194 | | - (master_doc, 'pyglotaran', 'pyglotaran Documentation', |
195 | | - author, 'pyglotaran', |
196 | | - 'Global and target analysis software package based on Python', |
197 | | - 'Miscellaneous'), |
| 187 | + ( |
| 188 | + master_doc, |
| 189 | + "pyglotaran", |
| 190 | + "pyglotaran Documentation", |
| 191 | + author, |
| 192 | + "pyglotaran", |
| 193 | + "Global and target analysis software package based on Python", |
| 194 | + "Miscellaneous", |
| 195 | + ), |
198 | 196 | ] |
199 | 197 |
|
200 | 198 |
|
|
213 | 211 | # epub_uid = '' |
214 | 212 |
|
215 | 213 | # A list of files that should not be packed into the epub file. |
216 | | -epub_exclude_files = ['search.html'] |
| 214 | +epub_exclude_files = ["search.html"] |
217 | 215 |
|
218 | 216 |
|
219 | 217 | # -- Extension configuration ------------------------------------------------- |
220 | 218 |
|
221 | 219 | # -- Options for intersphinx extension --------------------------------------- |
222 | 220 |
|
223 | 221 | intersphinx_mapping = { |
224 | | - 'numpy': ('http://docs.scipy.org/doc/numpy/', None), |
225 | | - 'xarray': ('http://xarray.pydata.org/en/stable/', None), |
226 | | - 'https://docs.python.org/': None |
| 222 | + "numpy": ("http://docs.scipy.org/doc/numpy/", None), |
| 223 | + "xarray": ("http://xarray.pydata.org/en/stable/", None), |
| 224 | + "https://docs.python.org/": None, |
227 | 225 | } |
228 | 226 |
|
229 | | -ipython_savefig_dir = 'images/plot' |
| 227 | +ipython_savefig_dir = "images/plot" |
230 | 228 |
|
231 | 229 | # -- Options for extlinks extension --------------------------------------- |
232 | 230 | extlinks = { |
233 | | - 'numpydoc': ('https://docs.scipy.org/doc/numpy/reference/generated/numpy.%s.html', 'numpy.'), |
234 | | - 'scipydoc': ('https://docs.scipy.org/doc/scipy/reference/generated/scipy.%s.html', 'scipy.'), |
235 | | - 'xarraydoc': ('https://xarray.pydata.org/en/stable/generated/xarray.%s.html', 'xarray.'), |
| 231 | + "numpydoc": ("https://docs.scipy.org/doc/numpy/reference/generated/numpy.%s.html", "numpy."), |
| 232 | + "scipydoc": ("https://docs.scipy.org/doc/scipy/reference/generated/scipy.%s.html", "scipy."), |
| 233 | + "xarraydoc": ("https://xarray.pydata.org/en/stable/generated/xarray.%s.html", "xarray."), |
236 | 234 | } |
0 commit comments