-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Argument and its type joined in docs #3056
Comments
I agree, this is definitely not ideal. It's definitely an upstream issue with the theme we use for our docs -- possibly readthedocs/sphinx_rtd_theme#750? It would be great if you (or anyone else) wants to look into this. |
It is an issue of incompatibilities with sphinx_rtd_theme and sphinx2, and I am not sure when will it be solved, I have looked a little into it but for now I don't know how. There is one small problem with xarray doc generation behaviour. In the I have no clear preference between sphinx1 or sphinx2, but both online and local docs should be the same. If you prefer sphinx2, I have no problem modifying |
This issue has nearly no effect on users, but (at least for me) it is quite bothering aesthetically. It also looks like something simple to solve even though I am not an sphinx expert so I am not sure.
In the docstring, there is a colon between the name of one argument and its type, however, in the online documentation, the name and the type are smashed together. In the case of
xr.align
:I think it would be more readable and appealing if there was some kind of separation between the two.
The text was updated successfully, but these errors were encountered: