Skip to content

Fix spacing between parameter and parameter type in the API docs #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2019
Merged

Fix spacing between parameter and parameter type in the API docs #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config

from dask_jobqueue import __version__ as version

# -- Path setup --------------------------------------------------------------

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


from dask_jobqueue import __version__ as version

# The full version, including alpha/beta/rc tags.
# release = '0.1.0'
release = version
Expand Down Expand Up @@ -198,3 +198,13 @@
"issue": ("https://github.com/dask/dask-jobqueue/issues/%s", "GH#"),
"pr": ("https://github.com/dask/dask-jobqueue/pull/%s", "GH#"),
}


# Temporary work-around for spacing problem between parameter and parameter
# type in the doc, see https://github.com/numpy/numpydoc/issues/215. The bug
# has been fixed in sphinx (https://github.com/sphinx-doc/sphinx/pull/5976) but
# through a change in sphinx basic.css except rtd_theme does not use basic.css.
# In an ideal world, this would get fixed in this PR:
# https://github.com/readthedocs/sphinx_rtd_theme/pull/747/files
def setup(app):
app.add_stylesheet("basic.css")