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.

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

Jump to bottom

Ugly docstrings generated by Sphinx #58

Closed
santisoler opened this issue Apr 17, 2019 · 3 comments · Fixed by #59
Closed

Ugly docstrings generated by Sphinx #58

santisoler opened this issue Apr 17, 2019 · 3 comments · Fixed by #59
Labels
bug Report a problem that needs to be fixed

Comments

@santisoler
Copy link
Member

Description of the problem

On the dev version of the Harmonica documentation, Sphinx is not compiling the docstrings right.
For example, on normal_gravity docstring the Parameters and Returns mix the variable name with the variable type.

I leave a screenshot of the current normal_gravity docstring.
harmonica-docs
@santisoler santisoler added the bug Report a problem that needs to be fixed label Apr 17, 2019
@leouieda
Copy link
Member

This is a bug in the sphinx_rtd_theme 0.4.3 (readthedocs/sphinx_rtd_theme#750). Could you please try setting the version in the environment.yml and requirements-dev.txt to =0.4.2 and see is that fixes it?

@santisoler
Copy link
Member Author

@leouieda I changed the sphinx_rtd_theme to 0.4.2 and 0.4.1 on environment.yml and built the docs locally without any improvement.

I've realized that sphinx has released a new 2.0.0 version a few weeks ago.
With the following setup, it works well:

  • sphinx = 1.8.5
  • sphinx_rtd_theme = 0.4.3

So I think the problem is with sphinx and not with the theme.

@leouieda
Copy link
Member

Oh, that's good to know. Would you mind opening a PR to pin sphinx to 1.8.5? We'll need this until there is a fix for all of our projects (verde, rockhound, pooch).

This was referenced Apr 22, 2019
Merged
Merged
Merged
Merged
@jxu jxu mentioned this issue Jul 2, 2019
Open
@lesteve lesteve mentioned this issue Sep 12, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Report a problem that needs to be fixed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Pin sphinx to version 1.8.5 santisoler/harmonica
2 participants
@leouieda @santisoler