Skip to content

Commit 1f5bd79

Browse files
committed
flake8 and correct version import
1 parent aa74a5c commit 1f5bd79

File tree

2 files changed

+61
-60
lines changed

2 files changed

+61
-60
lines changed

docs/conf.py

Lines changed: 60 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@
2121
import sys
2222
from unittest import mock
2323

24+
import multipletau
25+
2426

2527
# include parent directory
2628
pdir = op.dirname(op.dirname(op.abspath(__file__)))
27-
sys.path.insert(0, pdir)
29+
sys.path.insert(0, pdir)
2830
# include extenstions
2931
sys.path.append(op.abspath('extensions'))
3032

@@ -43,8 +45,8 @@
4345
projectname = name
4446
projectdescription = description
4547

46-
exec(open(op.join(pdir, "multipletau/_version.py")).read())
47-
release = version #@UndefinedVariable
48+
49+
release = multipletau.__version__
4850

4951
# http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autodoc_member_order
5052
# Order class attributes and functions in separate blocks
@@ -59,7 +61,7 @@
5961
# -- General configuration ------------------------------------------------
6062

6163
# If your documentation needs a minimal Sphinx version, state it here.
62-
#needs_sphinx = '1.0'
64+
# needs_sphinx = '1.0'
6365

6466
# Add any Sphinx extension module names here, as strings. They can be
6567
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -75,15 +77,14 @@
7577
]
7678

7779

78-
7980
# Add any paths that contain templates here, relative to this directory.
8081
templates_path = ['_templates']
8182

8283
# The suffix of source filenames.
8384
source_suffix = '.rst'
8485

8586
# The encoding of source files.
86-
#source_encoding = 'utf-8-sig'
87+
# source_encoding = 'utf-8-sig'
8788

8889
# The master toctree document.
8990
master_doc = 'index'
@@ -98,44 +99,44 @@
9899
#
99100
# The short X.Y version.
100101
# The full version, including alpha/beta/rc tags.
101-
#release = version
102+
# release = version
102103

103104
# The language for content autogenerated by Sphinx. Refer to documentation
104105
# for a list of supported languages.
105-
#language = None
106+
# language = None
106107

107108
# There are two options for replacing |today|: either, you set today to some
108109
# non-false value, then it is used:
109-
#today = ''
110+
# today = ''
110111
# Else, today_fmt is used as the format for a strftime call.
111-
#today_fmt = '%B %d, %Y'
112+
# today_fmt = '%B %d, %Y'
112113

113114
# List of patterns, relative to source directory, that match files and
114115
# directories to ignore when looking for source files.
115116

116117
# The reST default role (used for this markup: `text`) to use for all
117118
# documents.
118-
#default_role = None
119+
# default_role = None
119120

120121
# If true, '()' will be appended to :func: etc. cross-reference text.
121-
#add_function_parentheses = True
122+
# add_function_parentheses = True
122123

123124
# If true, the current module name will be prepended to all description
124125
# unit titles (such as .. function::).
125-
#add_module_names = True
126+
# add_module_names = True
126127

127128
# If true, sectionauthor and moduleauthor directives will be shown in the
128129
# output. They are ignored by default.
129-
#show_authors = False
130+
# show_authors = False
130131

131132
# The name of the Pygments (syntax highlighting) style to use.
132-
#pygments_style = 'default'
133+
# pygments_style = 'default'
133134

134135
# A list of ignored prefixes for module index sorting.
135-
#modindex_common_prefix = []
136+
# modindex_common_prefix = []
136137

137138
# If true, keep warnings as "system message" paragraphs in the built documents.
138-
#keep_warnings = False
139+
# keep_warnings = False
139140

140141

141142
# -- Options for HTML output ----------------------------------------------
@@ -145,74 +146,74 @@
145146
html_theme = 'default'
146147

147148
# Add any paths that contain custom themes here, relative to this directory.
148-
#html_theme_path = []
149+
# html_theme_path = []
149150

150151
# The name for this set of Sphinx documents. If None, it defaults to
151152
# "<project> v<release> documentation".
152-
#html_title = None
153+
# html_title = None
153154

154155
# A shorter title for the navigation bar. Default is the same as html_title.
155-
#html_short_title = None
156+
# html_short_title = None
156157

157158
# The name of an image file (relative to this directory) to place at the top
158159
# of the sidebar.
159-
#html_logo = None
160+
# html_logo = None
160161

161162
# The name of an image file (within the static path) to use as favicon of the
162163
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
163164
# pixels large.
164-
#html_favicon = None
165+
# html_favicon = None
165166

166167
# Add any paths that contain custom static files (such as style sheets) here,
167168
# relative to this directory. They are copied after the builtin static files,
168169
# so a file named "default.css" will overwrite the builtin "default.css".
169-
#html_static_path = ['_static']
170+
# html_static_path = ['_static']
170171

171172
# Add any extra paths that contain custom files (such as robots.txt or
172173
# .htaccess) here, relative to this directory. These files are copied
173174
# directly to the root of the documentation.
174-
#html_extra_path = []
175+
# html_extra_path = []
175176

176177
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
177178
# using the given strftime format.
178-
#html_last_updated_fmt = '%b %d, %Y'
179+
# html_last_updated_fmt = '%b %d, %Y'
179180

180181
# If true, SmartyPants will be used to convert quotes and dashes to
181182
# typographically correct entities.
182-
#html_use_smartypants = True
183+
# html_use_smartypants = True
183184

184185
# Custom sidebar templates, maps document names to template names.
185-
#html_sidebars = {}
186+
# html_sidebars = {}
186187

187188
# Additional templates that should be rendered to pages, maps page names to
188189
# template names.
189-
#html_additional_pages = {}
190+
# html_additional_pages = {}
190191

191192
# If false, no module index is generated.
192-
#html_domain_indices = True
193+
# html_domain_indices = True
193194

194195
# If false, no index is generated.
195-
#html_use_index = True
196+
# html_use_index = True
196197

197198
# If true, the index is split into individual pages for each letter.
198-
#html_split_index = False
199+
# html_split_index = False
199200

200201
# If true, links to the reST sources are added to the pages.
201-
#html_show_sourcelink = True
202+
# html_show_sourcelink = True
202203

203204
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
204-
#html_show_sphinx = True
205+
# html_show_sphinx = True
205206

206207
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
207-
#html_show_copyright = True
208+
# html_show_copyright = True
208209

209210
# If true, an OpenSearch description file will be output, and all pages will
210211
# contain a <link> tag referring to it. The value of this option must be the
211212
# base URL from which the finished HTML is served.
212-
#html_use_opensearch = ''
213+
# html_use_opensearch = ''
213214

214215
# This is the file name suffix for HTML files (e.g. ".xhtml").
215-
#html_file_suffix = None
216+
# html_file_suffix = None
216217

217218
# Output file base name for HTML help builder.
218219
htmlhelp_basename = projectname+'doc'
@@ -221,43 +222,43 @@
221222
# -- Options for LaTeX output ---------------------------------------------
222223

223224
latex_elements = {
224-
# The paper size ('letterpaper' or 'a4paper').
225-
#'papersize': 'letterpaper',
225+
# The paper size ('letterpaper' or 'a4paper').
226+
# 'papersize': 'letterpaper',
226227

227-
# The font size ('10pt', '11pt' or '12pt').
228-
#'pointsize': '10pt',
228+
# The font size ('10pt', '11pt' or '12pt').
229+
# 'pointsize': '10pt',
229230

230-
# Additional stuff for the LaTeX preamble.
231-
#'preamble': '',
231+
# Additional stuff for the LaTeX preamble.
232+
# 'preamble': '',
232233
}
233234

234235
# Grouping the document tree into LaTeX files. List of tuples
235236
# (source start file, target name, title,
236237
# author, documentclass [howto, manual, or own class]).
237238
latex_documents = [
238-
('index', projectname+'.tex', projectname+' Documentation',
239-
author, 'manual'),
239+
('index', projectname+'.tex', projectname+' Documentation',
240+
author, 'manual'),
240241
]
241242

242243
# The name of an image file (relative to this directory) to place at the top of
243244
# the title page.
244-
#latex_logo = None
245+
# latex_logo = None
245246

246247
# For "manual" documents, if this is true, then toplevel headings are parts,
247248
# not chapters.
248-
#latex_use_parts = False
249+
# latex_use_parts = False
249250

250251
# If true, show page references after internal links.
251-
#latex_show_pagerefs = False
252+
# latex_show_pagerefs = False
252253

253254
# If true, show URL addresses after external links.
254-
#latex_show_urls = False
255+
# latex_show_urls = False
255256

256257
# Documents to append as an appendix to all manuals.
257-
#latex_appendices = []
258+
# latex_appendices = []
258259

259260
# If false, no module index is generated.
260-
#latex_domain_indices = True
261+
# latex_domain_indices = True
261262

262263

263264
# -- Options for manual page output ---------------------------------------
@@ -270,7 +271,7 @@
270271
]
271272

272273
# If true, show URL addresses after external links.
273-
#man_show_urls = False
274+
# man_show_urls = False
274275

275276

276277
# -- Options for Texinfo output -------------------------------------------
@@ -279,23 +280,23 @@
279280
# (source start file, target name, title, author,
280281
# dir menu entry, description, category)
281282
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'),
286287
]
287288

288289
# Documents to append as an appendix to all manuals.
289-
#texinfo_appendices = []
290+
# texinfo_appendices = []
290291

291292
# If false, no module index is generated.
292-
#texinfo_domain_indices = True
293+
# texinfo_domain_indices = True
293294

294295
# How to display URL addresses: 'footnote', 'no', or 'inline'.
295-
#texinfo_show_urls = 'footnote'
296+
# texinfo_show_urls = 'footnote'
296297

297298
# If true, do not generate a @detailmenu in the "Top" node's menu.
298-
#texinfo_no_detailmenu = False
299+
# texinfo_no_detailmenu = False
299300

300301
# -----------------------------------------------------------------------------
301302
# intersphinx

multipletau/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
7373
"""
7474
from .core import autocorrelate, correlate, correlate_numpy # noqa: F401
75-
from ._version import version as __version__ # noqa: F401
75+
from ._version import __version__, __version_tuple__ # noqa: F401
7676

7777
__author__ = u"Paul Müller"
7878
__license__ = "BSD (3 clause)"

0 commit comments

Comments
 (0)