Skip to content
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

Fix parameter : type merger with CSS change #14

Open
mrocklin opened this issue Jul 31, 2019 · 2 comments
Open

Fix parameter : type merger with CSS change #14

mrocklin opened this issue Jul 31, 2019 · 2 comments

Comments

@mrocklin
Copy link
Member

@lesteve in going through the diff for dask-jobqueue I noticed that you wrote this comment:

+# 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")

I wonder if we might upstream some changes to the dask-sphinx-theme to resolve it more generally across dask projects.

However, I also noticed that the sytling on API docs is now oddly centered (see https://jobqueue.dask.org/en/latest/generated/dask_jobqueue.OARCluster.html#dask_jobqueue.OARCluster) , so this might not be as easy as expected.

@lesteve
Copy link
Member

lesteve commented Aug 1, 2019

Ideally this would be done in the sphinx_rtd_theme PR readthedocs/sphinx_rtd_theme#747 as I say in the comment but the PR hasn't received too much attention it seems, probably because it is quite a big change for theme. I have not tried reaching out in the PR I have to admit.

Note: the dask-jobqueue work-around was done in dask/dask-jobqueue#301 and has a bit more info than the comment.

I have to say that the change in centering doesn't bother me too much. That would certainly be something worth reporting to sphinx_rtd_theme if they decide to inherit from the sphinx basic theme.

I was also wondering why dask and distributed did not seem to be affected by this problem but maybe this is because you are not using autosummary the same way that we do.

@lesteve
Copy link
Member

lesteve commented Aug 1, 2019

I have not tried reaching out in the PR I have to admit.

Update: I added a comment in readthedocs/sphinx_rtd_theme#766

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

No branches or pull requests

2 participants