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 for Python type annotations #139

Closed
AWhetter opened this issue Jun 6, 2018 · 2 comments
Closed

Support for Python type annotations #139

AWhetter opened this issue Jun 6, 2018 · 2 comments
Labels
Good First Issue Good issue for first time contributors Language: Python

Comments

@AWhetter
Copy link
Collaborator

AWhetter commented Jun 6, 2018

The astroid integration hasn't been tested with type annotations at all. We should check if they're being output at the moment, and if not then output type annotations with how Sphinx normally would.

@AWhetter AWhetter added Language: Python Good First Issue Good issue for first time contributors labels Jun 6, 2018
@deeplook
Copy link

In what state is this issue right now? I'm trying to get https://github.com/agronholm/sphinx-autodoc-typehints working with this package (https://github.com/rtfd/sphinx-autoapi), but I'm not seeing any expected outcome.

@AWhetter
Copy link
Collaborator Author

I've added support for type annotations in the documentation generation and the autodoc directives. Complete support for type comments (#162) is blocked by an issue in astroid.

autoapi won't work with sphinx-autodoc-typehints because it expects to be passed live Python objects by autodoc, but our autodoc directives can only supply autoapi objects. To support the features of sphinx-autodoc-typehints we would have to make our own autoapi equivalent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good issue for first time contributors Language: Python
Projects
None yet
Development

No branches or pull requests

2 participants