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.

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

Support napoleon and google style docs #6

Open
sotte opened this issue Sep 11, 2016 · 1 comment
Open

Support napoleon and google style docs #6

sotte opened this issue Sep 11, 2016 · 1 comment

Comments

@sotte
Copy link

sotte commented Sep 11, 2016

I normally sphinx-napoleon and the "google style" for docs. It would be great if sphinx-autodoc-annotation supported this!

class MyClass: pass

def f(x: str, y: MyClass) -> str:
    """
    Do something...

    Args:
        x: some string
        y: something important

    Return:
        the same string
    """
    print(x)
    return x

Currently the output looks like this:
sphinx_autodoc_annotation_napoleon

@evanunderscore
Copy link

Napoleon works by transforming docstrings, so this may work out of the box if you put sphinx.ext.napoleon before sphinx_autodoc_annotation. I haven't tested it, but the same thing works for sphinx-autodoc-typehints.

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

No branches or pull requests

2 participants