-
Notifications
You must be signed in to change notification settings - Fork 432
Make Sphinx understand Google docstring style #241
Comments
The right thing to do here is for our code to conform to whatever the Python-language-wide accepted standard is rather than teach the standard tools to understand our code. :-) |
I don't know if Sphinx is "Python-language-wide accepted", but python.org is built with it, so that's good. Also, Google style docstrings are pretty well known, so there may be a Sphinx plug-in. I should've made it clear that no code should be written / kittens harmed in the resolving of this issue. |
And here's your sign: https://pypi.python.org/pypi/sphinxcontrib-napoleon |
Even better it's already in Somehow it's missing that image I posted though. |
@nathanielmanistaatgoogle It seems the webhook to auto-build isn't set up. When I view webhooks for a project I am an admin for, I see: Can you check out https://github.com/google/oauth2client/settings/hooks and see if the hook is set up? If not, we'll need to figure out a way to do it (may involve you creating an account on readthedocs.org). |
FWIW I manually forced a rebuild and the rendering issue is resolved: |
Your suspicion is correct; ReadTheDocs does not appear under "Services" at this time. |
(For posterity:) Added easily via: https://read-the-docs.readthedocs.org/en/latest/webhooks.html |
Currently, certain things don't get build as expected:
The other option is just to convert the docstrings to Sphinx/ReST style (maybe could go nicely with #137).
The text was updated successfully, but these errors were encountered: