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

Incorrect parameter formatting in documentation #1548

Closed
kohr-h opened this issue Apr 1, 2020 · 3 comments
Closed

Incorrect parameter formatting in documentation #1548

kohr-h opened this issue Apr 1, 2020 · 3 comments

Comments

@kohr-h
Copy link
Member

kohr-h commented Apr 1, 2020

For a while now, the parameters of functions are not displayed correctly in the documentation. See for instance here. It seems as if the colon between name and type of the parameter gets swallowed and the two get smashed together.

I saw the same issue in the doc window of the Spyder IDE, so I suspect that it has to do with a Sphinx update. Maybe numpydoc needs to be patched.

@kohr-h
Copy link
Member Author

kohr-h commented Apr 1, 2020

This is a known issue in the Sphinx RTD theme: readthedocs/sphinx_rtd_theme#746

A somewhat brutal fix that we could import: geopandas/geopandas#1299

@kohr-h
Copy link
Member Author

kohr-h commented Apr 1, 2020

Indeed fixed by #1549, so closing this for now. We should observe the sphinx-rtd-theme issue.

@kohr-h kohr-h closed this as completed Apr 1, 2020
@kohr-h
Copy link
Member Author

kohr-h commented May 6, 2020

The sphinx_rtd_theme issue has been closed as solved. We can remove our workaround as soon as a release is availble. I'll open a new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant