Skip to content

Commit dcb5ec7

Browse files
committed
Switch to Sphinx 1.3
1 parent 580d0d2 commit dcb5ec7

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

doc/conf.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,19 @@
2929
# -- General configuration ------------------------------------------------
3030

3131
# If your documentation needs a minimal Sphinx version, state it here.
32-
#needs_sphinx = '1.0'
32+
needs_sphinx = '1.3' # for sphinx.ext.napoleon
3333

3434
# Add any Sphinx extension module names here, as strings. They can be
3535
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3636
# ones.
3737
extensions = [
3838
'sphinx.ext.autodoc',
3939
'sphinx.ext.viewcode',
40-
# support for NumPy-style docstrings:
41-
'sphinxcontrib.napoleon', # Will be 'sphinx.ext.napoleon' in Sphinx >= 1.3
40+
'sphinx.ext.napoleon', # support for NumPy-style docstrings
4241
]
4342

44-
autoclass_content = "init"
45-
autodoc_member_order = "bysource"
43+
autoclass_content = 'init'
44+
autodoc_member_order = 'bysource'
4645

4746
napoleon_google_docstring = False
4847
napoleon_numpy_docstring = True
@@ -128,7 +127,7 @@
128127

129128
# The theme to use for HTML and HTML Help pages. See the documentation for
130129
# a list of builtin themes.
131-
html_theme = 'default'
130+
html_theme = 'sphinx_rtd_theme'
132131

133132
# Theme options are theme-specific and customize the look and feel of a theme
134133
# further. For a list of options available for each theme, see the

doc/requirements.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
jinja2
2-
pygments
3-
sphinx
4-
sphinxcontrib-napoleon
1+
Jinja2
2+
Pygments
3+
Sphinx>=1.3

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ def run_tests(self):
1414
errno = pytest.main(self.test_args)
1515
sys.exit(errno)
1616

17+
__version__ = "unknown"
1718

1819
# "import" __version__
1920
for line in open("jack.py"):
@@ -25,7 +26,7 @@ def run_tests(self):
2526
name="JACK-Client",
2627
version=__version__,
2728
py_modules=["jack"],
28-
install_requires=['cffi'],
29+
install_requires=["CFFI"],
2930
author="Matthias Geier",
3031
author_email="[email protected]",
3132
description="JACK Audio Connection Kit (JACK) Client for Python",

0 commit comments

Comments
 (0)