|
21 | 21 | import sys
|
22 | 22 | from unittest import mock
|
23 | 23 |
|
| 24 | +import multipletau |
| 25 | + |
24 | 26 |
|
25 | 27 | # include parent directory
|
26 | 28 | pdir = op.dirname(op.dirname(op.abspath(__file__)))
|
27 |
| -sys.path.insert(0, pdir) |
| 29 | +sys.path.insert(0, pdir) |
28 | 30 | # include extenstions
|
29 | 31 | sys.path.append(op.abspath('extensions'))
|
30 | 32 |
|
|
43 | 45 | projectname = name
|
44 | 46 | projectdescription = description
|
45 | 47 |
|
46 |
| -exec(open(op.join(pdir, "multipletau/_version.py")).read()) |
47 |
| -release = version #@UndefinedVariable |
| 48 | + |
| 49 | +release = multipletau.__version__ |
48 | 50 |
|
49 | 51 | # http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autodoc_member_order
|
50 | 52 | # Order class attributes and functions in separate blocks
|
|
59 | 61 | # -- General configuration ------------------------------------------------
|
60 | 62 |
|
61 | 63 | # If your documentation needs a minimal Sphinx version, state it here.
|
62 |
| -#needs_sphinx = '1.0' |
| 64 | +# needs_sphinx = '1.0' |
63 | 65 |
|
64 | 66 | # Add any Sphinx extension module names here, as strings. They can be
|
65 | 67 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
75 | 77 | ]
|
76 | 78 |
|
77 | 79 |
|
78 |
| - |
79 | 80 | # Add any paths that contain templates here, relative to this directory.
|
80 | 81 | templates_path = ['_templates']
|
81 | 82 |
|
82 | 83 | # The suffix of source filenames.
|
83 | 84 | source_suffix = '.rst'
|
84 | 85 |
|
85 | 86 | # The encoding of source files.
|
86 |
| -#source_encoding = 'utf-8-sig' |
| 87 | +# source_encoding = 'utf-8-sig' |
87 | 88 |
|
88 | 89 | # The master toctree document.
|
89 | 90 | master_doc = 'index'
|
|
98 | 99 | #
|
99 | 100 | # The short X.Y version.
|
100 | 101 | # The full version, including alpha/beta/rc tags.
|
101 |
| -#release = version |
| 102 | +# release = version |
102 | 103 |
|
103 | 104 | # The language for content autogenerated by Sphinx. Refer to documentation
|
104 | 105 | # for a list of supported languages.
|
105 |
| -#language = None |
| 106 | +# language = None |
106 | 107 |
|
107 | 108 | # There are two options for replacing |today|: either, you set today to some
|
108 | 109 | # non-false value, then it is used:
|
109 |
| -#today = '' |
| 110 | +# today = '' |
110 | 111 | # Else, today_fmt is used as the format for a strftime call.
|
111 |
| -#today_fmt = '%B %d, %Y' |
| 112 | +# today_fmt = '%B %d, %Y' |
112 | 113 |
|
113 | 114 | # List of patterns, relative to source directory, that match files and
|
114 | 115 | # directories to ignore when looking for source files.
|
115 | 116 |
|
116 | 117 | # The reST default role (used for this markup: `text`) to use for all
|
117 | 118 | # documents.
|
118 |
| -#default_role = None |
| 119 | +# default_role = None |
119 | 120 |
|
120 | 121 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
121 |
| -#add_function_parentheses = True |
| 122 | +# add_function_parentheses = True |
122 | 123 |
|
123 | 124 | # If true, the current module name will be prepended to all description
|
124 | 125 | # unit titles (such as .. function::).
|
125 |
| -#add_module_names = True |
| 126 | +# add_module_names = True |
126 | 127 |
|
127 | 128 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
128 | 129 | # output. They are ignored by default.
|
129 |
| -#show_authors = False |
| 130 | +# show_authors = False |
130 | 131 |
|
131 | 132 | # The name of the Pygments (syntax highlighting) style to use.
|
132 |
| -#pygments_style = 'default' |
| 133 | +# pygments_style = 'default' |
133 | 134 |
|
134 | 135 | # A list of ignored prefixes for module index sorting.
|
135 |
| -#modindex_common_prefix = [] |
| 136 | +# modindex_common_prefix = [] |
136 | 137 |
|
137 | 138 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
138 |
| -#keep_warnings = False |
| 139 | +# keep_warnings = False |
139 | 140 |
|
140 | 141 |
|
141 | 142 | # -- Options for HTML output ----------------------------------------------
|
|
145 | 146 | html_theme = 'default'
|
146 | 147 |
|
147 | 148 | # Add any paths that contain custom themes here, relative to this directory.
|
148 |
| -#html_theme_path = [] |
| 149 | +# html_theme_path = [] |
149 | 150 |
|
150 | 151 | # The name for this set of Sphinx documents. If None, it defaults to
|
151 | 152 | # "<project> v<release> documentation".
|
152 |
| -#html_title = None |
| 153 | +# html_title = None |
153 | 154 |
|
154 | 155 | # A shorter title for the navigation bar. Default is the same as html_title.
|
155 |
| -#html_short_title = None |
| 156 | +# html_short_title = None |
156 | 157 |
|
157 | 158 | # The name of an image file (relative to this directory) to place at the top
|
158 | 159 | # of the sidebar.
|
159 |
| -#html_logo = None |
| 160 | +# html_logo = None |
160 | 161 |
|
161 | 162 | # The name of an image file (within the static path) to use as favicon of the
|
162 | 163 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
163 | 164 | # pixels large.
|
164 |
| -#html_favicon = None |
| 165 | +# html_favicon = None |
165 | 166 |
|
166 | 167 | # Add any paths that contain custom static files (such as style sheets) here,
|
167 | 168 | # relative to this directory. They are copied after the builtin static files,
|
168 | 169 | # so a file named "default.css" will overwrite the builtin "default.css".
|
169 |
| -#html_static_path = ['_static'] |
| 170 | +# html_static_path = ['_static'] |
170 | 171 |
|
171 | 172 | # Add any extra paths that contain custom files (such as robots.txt or
|
172 | 173 | # .htaccess) here, relative to this directory. These files are copied
|
173 | 174 | # directly to the root of the documentation.
|
174 |
| -#html_extra_path = [] |
| 175 | +# html_extra_path = [] |
175 | 176 |
|
176 | 177 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
177 | 178 | # using the given strftime format.
|
178 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 179 | +# html_last_updated_fmt = '%b %d, %Y' |
179 | 180 |
|
180 | 181 | # If true, SmartyPants will be used to convert quotes and dashes to
|
181 | 182 | # typographically correct entities.
|
182 |
| -#html_use_smartypants = True |
| 183 | +# html_use_smartypants = True |
183 | 184 |
|
184 | 185 | # Custom sidebar templates, maps document names to template names.
|
185 |
| -#html_sidebars = {} |
| 186 | +# html_sidebars = {} |
186 | 187 |
|
187 | 188 | # Additional templates that should be rendered to pages, maps page names to
|
188 | 189 | # template names.
|
189 |
| -#html_additional_pages = {} |
| 190 | +# html_additional_pages = {} |
190 | 191 |
|
191 | 192 | # If false, no module index is generated.
|
192 |
| -#html_domain_indices = True |
| 193 | +# html_domain_indices = True |
193 | 194 |
|
194 | 195 | # If false, no index is generated.
|
195 |
| -#html_use_index = True |
| 196 | +# html_use_index = True |
196 | 197 |
|
197 | 198 | # If true, the index is split into individual pages for each letter.
|
198 |
| -#html_split_index = False |
| 199 | +# html_split_index = False |
199 | 200 |
|
200 | 201 | # If true, links to the reST sources are added to the pages.
|
201 |
| -#html_show_sourcelink = True |
| 202 | +# html_show_sourcelink = True |
202 | 203 |
|
203 | 204 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
204 |
| -#html_show_sphinx = True |
| 205 | +# html_show_sphinx = True |
205 | 206 |
|
206 | 207 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
207 |
| -#html_show_copyright = True |
| 208 | +# html_show_copyright = True |
208 | 209 |
|
209 | 210 | # If true, an OpenSearch description file will be output, and all pages will
|
210 | 211 | # contain a <link> tag referring to it. The value of this option must be the
|
211 | 212 | # base URL from which the finished HTML is served.
|
212 |
| -#html_use_opensearch = '' |
| 213 | +# html_use_opensearch = '' |
213 | 214 |
|
214 | 215 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
215 |
| -#html_file_suffix = None |
| 216 | +# html_file_suffix = None |
216 | 217 |
|
217 | 218 | # Output file base name for HTML help builder.
|
218 | 219 | htmlhelp_basename = projectname+'doc'
|
|
221 | 222 | # -- Options for LaTeX output ---------------------------------------------
|
222 | 223 |
|
223 | 224 | latex_elements = {
|
224 |
| -# The paper size ('letterpaper' or 'a4paper'). |
225 |
| -#'papersize': 'letterpaper', |
| 225 | + # The paper size ('letterpaper' or 'a4paper'). |
| 226 | + # 'papersize': 'letterpaper', |
226 | 227 |
|
227 |
| -# The font size ('10pt', '11pt' or '12pt'). |
228 |
| -#'pointsize': '10pt', |
| 228 | + # The font size ('10pt', '11pt' or '12pt'). |
| 229 | + # 'pointsize': '10pt', |
229 | 230 |
|
230 |
| -# Additional stuff for the LaTeX preamble. |
231 |
| -#'preamble': '', |
| 231 | + # Additional stuff for the LaTeX preamble. |
| 232 | + # 'preamble': '', |
232 | 233 | }
|
233 | 234 |
|
234 | 235 | # Grouping the document tree into LaTeX files. List of tuples
|
235 | 236 | # (source start file, target name, title,
|
236 | 237 | # author, documentclass [howto, manual, or own class]).
|
237 | 238 | latex_documents = [
|
238 |
| - ('index', projectname+'.tex', projectname+' Documentation', |
239 |
| - author, 'manual'), |
| 239 | + ('index', projectname+'.tex', projectname+' Documentation', |
| 240 | + author, 'manual'), |
240 | 241 | ]
|
241 | 242 |
|
242 | 243 | # The name of an image file (relative to this directory) to place at the top of
|
243 | 244 | # the title page.
|
244 |
| -#latex_logo = None |
| 245 | +# latex_logo = None |
245 | 246 |
|
246 | 247 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
247 | 248 | # not chapters.
|
248 |
| -#latex_use_parts = False |
| 249 | +# latex_use_parts = False |
249 | 250 |
|
250 | 251 | # If true, show page references after internal links.
|
251 |
| -#latex_show_pagerefs = False |
| 252 | +# latex_show_pagerefs = False |
252 | 253 |
|
253 | 254 | # If true, show URL addresses after external links.
|
254 |
| -#latex_show_urls = False |
| 255 | +# latex_show_urls = False |
255 | 256 |
|
256 | 257 | # Documents to append as an appendix to all manuals.
|
257 |
| -#latex_appendices = [] |
| 258 | +# latex_appendices = [] |
258 | 259 |
|
259 | 260 | # If false, no module index is generated.
|
260 |
| -#latex_domain_indices = True |
| 261 | +# latex_domain_indices = True |
261 | 262 |
|
262 | 263 |
|
263 | 264 | # -- Options for manual page output ---------------------------------------
|
|
270 | 271 | ]
|
271 | 272 |
|
272 | 273 | # If true, show URL addresses after external links.
|
273 |
| -#man_show_urls = False |
| 274 | +# man_show_urls = False |
274 | 275 |
|
275 | 276 |
|
276 | 277 | # -- Options for Texinfo output -------------------------------------------
|
|
279 | 280 | # (source start file, target name, title, author,
|
280 | 281 | # dir menu entry, description, category)
|
281 | 282 | texinfo_documents = [
|
282 |
| - ('index', projectname, projectname+' Documentation', |
283 |
| - author, projectname, |
284 |
| - projectdescription, |
285 |
| - 'Numeric'), |
| 283 | + ('index', projectname, projectname+' Documentation', |
| 284 | + author, projectname, |
| 285 | + projectdescription, |
| 286 | + 'Numeric'), |
286 | 287 | ]
|
287 | 288 |
|
288 | 289 | # Documents to append as an appendix to all manuals.
|
289 |
| -#texinfo_appendices = [] |
| 290 | +# texinfo_appendices = [] |
290 | 291 |
|
291 | 292 | # If false, no module index is generated.
|
292 |
| -#texinfo_domain_indices = True |
| 293 | +# texinfo_domain_indices = True |
293 | 294 |
|
294 | 295 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
295 |
| -#texinfo_show_urls = 'footnote' |
| 296 | +# texinfo_show_urls = 'footnote' |
296 | 297 |
|
297 | 298 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
298 |
| -#texinfo_no_detailmenu = False |
| 299 | +# texinfo_no_detailmenu = False |
299 | 300 |
|
300 | 301 | # -----------------------------------------------------------------------------
|
301 | 302 | # intersphinx
|
|
0 commit comments