Skip to content

add napoleon ext - #103

Merged
lsetiawan merged 2 commits into
ODM2:masterfrom
ocefpaf:fix_doc_style
Sep 29, 2017
Merged

lsetiawan merged 2 commits into
ODM2:masterfrom
ocefpaf:fix_doc_style

Conversation

@ocefpaf

@ocefpaf ocefpaf commented Sep 29, 2017

Copy link
Copy Markdown
Member

Closes #102

Comment thread docs/source/conf.py
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lsetiawan I forgot that napoleon, the extension for the numpy/scipy and google style docstrings, is builtin and we still need to enable it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching that! :)

Comment thread docs/source/modules.rst Outdated
:mod:`Read Services`
----------------------

.. automodule:: odm2api.ODM2.services.readService

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you maybe remove this change and keep the other one to conf.py so I can merge? Thanks 😄

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@lsetiawan

lsetiawan commented Sep 29, 2017 •

Copy link
Copy Markdown
Member

It works now with the built in napoleon extension! 🎉

screenshot 2017-09-29 08 57 16

@lsetiawan lsetiawan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ocefpaf. I'll merge once it's green!

@lsetiawan
lsetiawan merged commit d5eb408 into ODM2:master Sep 29, 2017
@ocefpaf
ocefpaf deleted the fix_doc_style branch September 29, 2017 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants