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.

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

Conversation

lesteve
Copy link
Member

@lesteve lesteve commented Jul 26, 2019

This can be quite confusing: e.g. it looks like the parameters are queuestr and projectstr in this screenshot:
image

The simplest fix I found was to add basic.css through setup(app) in conf.py

cc @TomAugspurger since i saw he had similar problems in dask-ml which he fixed by pinning sphinx < 2 (except that we can not do that on RTD, which is another story by itself ...)

This is the same screenshot as above from a locally generated doc:
image

This is a work-around for a sphinx/numpydoc/sphinx_rtd_theme bug.

Also fix flake8 issue in conf.py.
@lesteve
Copy link
Member Author

lesteve commented Jul 26, 2019

I am going to merge this one, let me know if you spot problems in the doc that may be related to this PR.

@lesteve lesteve merged commit a8de8db into dask:master Jul 26, 2019
@lesteve lesteve deleted the fix-api-doc-parameter-spacing branch July 26, 2019 11:43
@guillaumeeb
Copy link
Member

Thanks @lesteve! Noticed this too, this caused some missunderstanding in some issues. It's really nice to have it fixed!

ocaisa pushed a commit to ocaisa/dask-jobqueue that referenced this pull request Jul 22, 2021
This was included in dask#301 but has since been resolved somewhere upstream
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants