Skip to content

Commit 866ac00

Browse files
authored
Fixing the package to include commands (#1649)
* Fixing the package to include commands. Fixes #1645
1 parent 2b0a1e7 commit 866ac00

File tree

4 files changed

+124
-112
lines changed

4 files changed

+124
-112
lines changed

docs/conf.py

+82-70
Original file line numberDiff line numberDiff line change
@@ -16,212 +16,218 @@
1616
# If extensions (or modules to document with autodoc) are in another directory,
1717
# add these directories to sys.path here. If the directory is relative to the
1818
# documentation root, use os.path.abspath to make it absolute, like shown here.
19-
#sys.path.insert(0, os.path.abspath('.'))
19+
# sys.path.insert(0, os.path.abspath('.'))
2020
sys.path.append(os.path.abspath(os.path.pardir))
2121

2222
# -- General configuration ----------------------------------------------------
2323

2424
# If your documentation needs a minimal Sphinx version, state it here.
25-
#needs_sphinx = '1.0'
25+
# needs_sphinx = '1.0'
2626

2727
# Add any Sphinx extension module names here, as strings. They can be
2828
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode']
29+
extensions = [
30+
"sphinx.ext.autodoc",
31+
"sphinx.ext.doctest",
32+
"sphinx.ext.viewcode"
33+
]
3034

3135
# Add any paths that contain templates here, relative to this directory.
32-
templates_path = ['_templates']
36+
templates_path = ["_templates"]
3337

3438
# The suffix of source filenames.
35-
source_suffix = '.rst'
39+
source_suffix = ".rst"
3640

3741
# The encoding of source files.
38-
#source_encoding = 'utf-8-sig'
42+
# source_encoding = 'utf-8-sig'
3943

4044
# The master toctree document.
41-
master_doc = 'index'
45+
master_doc = "index"
4246

4347
# General information about the project.
44-
project = 'redis-py'
45-
copyright = '2016, Andy McCurdy'
48+
project = "redis-py"
49+
copyright = "2016, Andy McCurdy"
4650

4751
# The version info for the project you're documenting, acts as replacement for
4852
# |version| and |release|, also used in various other places throughout the
4953
# built documents.
5054
#
5155
# The short X.Y version.
52-
version = '2.10.5'
56+
version = "2.10.5"
5357
# The full version, including alpha/beta/rc tags.
54-
release = '2.10.5'
58+
release = "2.10.5"
5559

5660
# The language for content autogenerated by Sphinx. Refer to documentation
5761
# for a list of supported languages.
58-
#language = None
62+
# language = None
5963

6064
# There are two options for replacing |today|: either, you set today to some
6165
# non-false value, then it is used:
62-
#today = ''
66+
# today = ''
6367
# Else, today_fmt is used as the format for a strftime call.
64-
#today_fmt = '%B %d, %Y'
68+
# today_fmt = '%B %d, %Y'
6569

6670
# List of patterns, relative to source directory, that match files and
6771
# directories to ignore when looking for source files.
68-
exclude_patterns = ['_build']
72+
exclude_patterns = ["_build"]
6973

7074
# The reST default role (used for this markup: `text`) to use for all
7175
# documents.
72-
#default_role = None
76+
# default_role = None
7377

7478
# If true, '()' will be appended to :func: etc. cross-reference text.
75-
#add_function_parentheses = True
79+
# add_function_parentheses = True
7680

7781
# If true, the current module name will be prepended to all description
7882
# unit titles (such as .. function::).
79-
#add_module_names = True
83+
# add_module_names = True
8084

8185
# If true, sectionauthor and moduleauthor directives will be shown in the
8286
# output. They are ignored by default.
83-
#show_authors = False
87+
# show_authors = False
8488

8589
# The name of the Pygments (syntax highlighting) style to use.
86-
pygments_style = 'sphinx'
90+
pygments_style = "sphinx"
8791

8892
# A list of ignored prefixes for module index sorting.
89-
#modindex_common_prefix = []
93+
# modindex_common_prefix = []
9094

9195

9296
# -- Options for HTML output --------------------------------------------------
9397

9498
# The theme to use for HTML and HTML Help pages. See the documentation for
9599
# a list of builtin themes.
96-
html_theme = 'default'
100+
html_theme = "default"
97101

98102
# Theme options are theme-specific and customize the look and feel of a theme
99103
# further. For a list of options available for each theme, see the
100104
# documentation.
101-
#html_theme_options = {}
105+
# html_theme_options = {}
102106

103107
# Add any paths that contain custom themes here, relative to this directory.
104-
#html_theme_path = []
108+
# html_theme_path = []
105109

106110
# The name for this set of Sphinx documents. If None, it defaults to
107111
# "<project> v<release> documentation".
108-
#html_title = None
112+
# html_title = None
109113

110114
# A shorter title for the navigation bar. Default is the same as html_title.
111-
#html_short_title = None
115+
# html_short_title = None
112116

113117
# The name of an image file (relative to this directory) to place at the top
114118
# of the sidebar.
115-
#html_logo = None
119+
# html_logo = None
116120

117121
# The name of an image file (within the static path) to use as favicon of the
118122
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119123
# pixels large.
120-
#html_favicon = None
124+
# html_favicon = None
121125

122126
# Add any paths that contain custom static files (such as style sheets) here,
123127
# relative to this directory. They are copied after the builtin static files,
124128
# so a file named "default.css" will overwrite the builtin "default.css".
125-
html_static_path = ['_static']
129+
html_static_path = ["_static"]
126130

127131
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128132
# using the given strftime format.
129-
#html_last_updated_fmt = '%b %d, %Y'
133+
# html_last_updated_fmt = '%b %d, %Y'
130134

131135
# If true, SmartyPants will be used to convert quotes and dashes to
132136
# typographically correct entities.
133-
#html_use_smartypants = True
137+
# html_use_smartypants = True
134138

135139
# Custom sidebar templates, maps document names to template names.
136-
#html_sidebars = {}
140+
# html_sidebars = {}
137141

138142
# Additional templates that should be rendered to pages, maps page names to
139143
# template names.
140-
#html_additional_pages = {}
144+
# html_additional_pages = {}
141145

142146
# If false, no module index is generated.
143-
#html_domain_indices = True
147+
# html_domain_indices = True
144148

145149
# If false, no index is generated.
146-
#html_use_index = True
150+
# html_use_index = True
147151

148152
# If true, the index is split into individual pages for each letter.
149-
#html_split_index = False
153+
# html_split_index = False
150154

151155
# If true, links to the reST sources are added to the pages.
152-
#html_show_sourcelink = True
156+
# html_show_sourcelink = True
153157

154158
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155-
#html_show_sphinx = True
159+
# html_show_sphinx = True
156160

157161
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158-
#html_show_copyright = True
162+
# html_show_copyright = True
159163

160164
# If true, an OpenSearch description file will be output, and all pages will
161165
# contain a <link> tag referring to it. The value of this option must be the
162166
# base URL from which the finished HTML is served.
163-
#html_use_opensearch = ''
167+
# html_use_opensearch = ''
164168

165169
# This is the file name suffix for HTML files (e.g. ".xhtml").
166-
#html_file_suffix = None
170+
# html_file_suffix = None
167171

168172
# Output file base name for HTML help builder.
169-
htmlhelp_basename = 'redis-pydoc'
173+
htmlhelp_basename = "redis-pydoc"
170174

171175

172176
# -- Options for LaTeX output -------------------------------------------------
173177

174178
latex_elements = {
175179
# The paper size ('letterpaper' or 'a4paper').
176-
#'papersize': 'letterpaper',
177-
180+
# 'papersize': 'letterpaper',
178181
# The font size ('10pt', '11pt' or '12pt').
179-
#'pointsize': '10pt',
180-
182+
# 'pointsize': '10pt',
181183
# Additional stuff for the LaTeX preamble.
182-
#'preamble': '',
184+
# 'preamble': '',
183185
}
184186

185187
# Grouping the document tree into LaTeX files. List of tuples
186188
# (source start file, target name, title, author, documentclass
187189
# [howto/manual]).
188190
latex_documents = [
189-
('index', 'redis-py.tex', 'redis-py Documentation',
190-
'Andy McCurdy', 'manual'),
191+
("index",
192+
"redis-py.tex",
193+
"redis-py Documentation",
194+
"Andy McCurdy",
195+
"manual"),
191196
]
192197

193198
# The name of an image file (relative to this directory) to place at the top of
194199
# the title page.
195-
#latex_logo = None
200+
# latex_logo = None
196201

197202
# For "manual" documents, if this is true, then toplevel headings are parts,
198203
# not chapters.
199-
#latex_use_parts = False
204+
# latex_use_parts = False
200205

201206
# If true, show page references after internal links.
202-
#latex_show_pagerefs = False
207+
# latex_show_pagerefs = False
203208

204209
# If true, show URL addresses after external links.
205-
#latex_show_urls = False
210+
# latex_show_urls = False
206211

207212
# Documents to append as an appendix to all manuals.
208-
#latex_appendices = []
213+
# latex_appendices = []
209214

210215
# If false, no module index is generated.
211-
#latex_domain_indices = True
216+
# latex_domain_indices = True
212217

213218

214219
# -- Options for manual page output -------------------------------------------
215220

216221
# One entry per manual page. List of tuples
217222
# (source start file, name, description, authors, manual section).
218-
man_pages = [
219-
('index', 'redis-py', 'redis-py Documentation',
220-
['Andy McCurdy'], 1)
221-
]
223+
man_pages = [(
224+
"index",
225+
"redis-py",
226+
"redis-py Documentation",
227+
["Andy McCurdy"], 1)]
222228

223229
# If true, show URL addresses after external links.
224-
#man_show_urls = False
230+
# man_show_urls = False
225231

226232

227233
# -- Options for Texinfo output -----------------------------------------------
@@ -230,21 +236,27 @@
230236
# (source start file, target name, title, author,
231237
# dir menu entry, description, category)
232238
texinfo_documents = [
233-
('index', 'redis-py', 'redis-py Documentation',
234-
'Andy McCurdy', 'redis-py',
235-
'One line description of project.', 'Miscellaneous'),
239+
(
240+
"index",
241+
"redis-py",
242+
"redis-py Documentation",
243+
"Andy McCurdy",
244+
"redis-py",
245+
"One line description of project.",
246+
"Miscellaneous",
247+
),
236248
]
237249

238250
# Documents to append as an appendix to all manuals.
239-
#texinfo_appendices = []
251+
# texinfo_appendices = []
240252

241253
# If false, no module index is generated.
242-
#texinfo_domain_indices = True
254+
# texinfo_domain_indices = True
243255

244256
# How to display URL addresses: 'footnote', 'no', or 'inline'.
245-
#texinfo_show_urls = 'footnote'
257+
# texinfo_show_urls = 'footnote'
246258

247-
epub_title = 'redis-py'
248-
epub_author = 'Andy McCurdy'
249-
epub_publisher = 'Andy McCurdy'
250-
epub_copyright = '2011, Andy McCurdy'
259+
epub_title = "redis-py"
260+
epub_author = "Andy McCurdy"
261+
epub_publisher = "Andy McCurdy"
262+
epub_copyright = "2011, Andy McCurdy"

redis/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def int_or_str(value):
3131
return value
3232

3333

34-
__version__ = '4.0.0b2'
34+
__version__ = '4.0.0b3'
3535
VERSION = tuple(map(int_or_str, __version__.split('.')))
3636

3737
__all__ = [

setup.cfg

-39
This file was deleted.

0 commit comments

Comments
 (0)