Skip to content

Commit a8de8db

Browse files
authored
Fix spacing between parameter and parameter type in the API docs (#301)
This is a work-around for a sphinx/numpydoc/sphinx_rtd_theme bug. Also fix flake8 issue in conf.py.
1 parent 5d0a8ca commit a8de8db

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/source/conf.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
# full list see the documentation:
77
# http://www.sphinx-doc.org/en/stable/config
88

9+
from dask_jobqueue import __version__ as version
10+
911
# -- Path setup --------------------------------------------------------------
1012

1113
# If extensions (or modules to document with autodoc) are in another directory,
@@ -24,8 +26,6 @@
2426
copyright = u"2018, Anaconda, Inc. and contributors"
2527

2628

27-
from dask_jobqueue import __version__ as version
28-
2929
# The full version, including alpha/beta/rc tags.
3030
# release = '0.1.0'
3131
release = version
@@ -198,3 +198,13 @@
198198
"issue": ("https://github.com/dask/dask-jobqueue/issues/%s", "GH#"),
199199
"pr": ("https://github.com/dask/dask-jobqueue/pull/%s", "GH#"),
200200
}
201+
202+
203+
# Temporary work-around for spacing problem between parameter and parameter
204+
# type in the doc, see https://github.com/numpy/numpydoc/issues/215. The bug
205+
# has been fixed in sphinx (https://github.com/sphinx-doc/sphinx/pull/5976) but
206+
# through a change in sphinx basic.css except rtd_theme does not use basic.css.
207+
# In an ideal world, this would get fixed in this PR:
208+
# https://github.com/readthedocs/sphinx_rtd_theme/pull/747/files
209+
def setup(app):
210+
app.add_stylesheet("basic.css")

0 commit comments

Comments
 (0)