Skip to content

Read The Docs not rendering API arguments : types correctly #690

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

Closed
mikofski opened this issue Apr 22, 2019 · 4 comments
Closed

Read The Docs not rendering API arguments : types correctly #690

mikofski opened this issue Apr 22, 2019 · 4 comments
Milestone

Comments

@mikofski
Copy link
Member

Describe the bug
there is no colon between args and types anymore

Screenshots
https://pvlib-python.readthedocs.io/en/latest/generated/pvlib.location.Location.get_solarposition.html#pvlib.location.Location.get_solarposition
image

Expected behavior
there should be colons, like this
https://pvlib-python.readthedocs.io/en/stable/generated/pvlib.location.Location.get_solarposition.html
image

@wholmgren
Copy link
Member

wholmgren commented Apr 22, 2019

The "expected behavior" also looks bad because there's no space between the colons and the types. I'm guessing this is due to numpydoc or the sphinxrtd theme (or both). I saw there's a new numpydoc release so I manually triggered the doc build. Unfortunately there is now an error that prevents the build from completing. See here: https://readthedocs.org/projects/pvlib-python/builds/8948978/

@mikofski
Copy link
Member Author

From the error I think it's because the "see also" items in solar_zenith_analytical are all on the same line without commas. I think I should have put them on separate lines.

@mikofski
Copy link
Member Author

Okay, I think I got it working, needed sphinx.ext.napoleon extension, see this blogger

image

much better, right? there are a couple of options you can read about them here in napoleon docs, numpydoc is enabled by default. I played around with them, but I couldn't really see any differences.

@wholmgren
Copy link
Member

The "latest" docs are building successfully, so I'll close this.

Screen Shot 2019-04-24 at 7 26 21 AM

@wholmgren wholmgren added this to the 0.6.2 milestone Apr 24, 2019
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

2 participants