add napoleon ext #103
add napoleon ext #103
Conversation
| @@ -33,6 +33,7 @@ | |||
| extensions = [ | |||
| 'sphinx.ext.autodoc', | |||
| 'sphinx.ext.viewcode', | |||
| 'sphinx.ext.napoleon', | |||
There was a problem hiding this comment.
@lsetiawan I forgot that napoleon, the extension for the numpy/scipy and google style docstrings, is builtin and we still need to enable it.
docs/source/modules.rst
Outdated
| :mod:`Read Services` | ||
| ---------------------- | ||
|
|
||
| .. automodule:: odm2api.ODM2.services.readService |
There was a problem hiding this comment.
I haven't fixed all the docstring for this module yet. It's gonna be a mess except for one function getAffiliations. But I guess for now that's fine. The current docstrings still rendered, at lease now I can see it without going to the actual module python file.
There was a problem hiding this comment.
You don't need to merge this. I only sent the PR to show you with code that what was wrong was not your docstring 😄
There was a problem hiding this comment.
Could you maybe remove this change and keep the other one to conf.py so I can merge? Thanks 😄
|
It works now with the built in napoleon extension! 🎉
|
Closes #102