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.

Sign up for GitHub

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

Jump to bottom

Update docstrings to rely on mypy annotations and add sphinx autodoc extension #26

Closed
mattsb42-aws opened this issue Oct 8, 2017 · 1 comment
Closed

Update docstrings to rely on mypy annotations and add sphinx autodoc extension #26

mattsb42-aws opened this issue Oct 8, 2017 · 1 comment
Labels
blocked enhancement

Comments

@mattsb42-aws
Copy link
Member

mattsb42-aws commented Oct 8, 2017 •
edited
Loading

Sphinx autodoc extension that reads types from mypy annotations: https://pypi.python.org/pypi/sphinx-autodoc-typehints

This lets us both single-source typing hints and forces more granular typing hints in the Sphinx docs than is normally used.
@mattsb42-aws mattsb42-aws self-assigned this Oct 8, 2017
@mattsb42-aws mattsb42-aws mentioned this issue Oct 8, 2017
Merged
@mattsb42-aws
Copy link
Member Author

Unfortunately, it looks like sphinx-autodoc-typehints only works with Python 3 mypy annotations, not Python 2-compatible mypy annotations.

@mattsb42-aws mattsb42-aws removed their assignment Dec 10, 2018
farleyb-amazon pushed a commit that referenced this issue May 27, 2021
@texastony @alex-chew @lavaleri
feat: Improvements to the message decryption process (#26)
dfd4124 
See GHSA-89v2-g37m-g3ff

Co-authored-by: Alex Chew <alex@alexchew.net>
Co-authored-by: Valerie Lambert <lavaleri@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocked enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@texastony @mattsb42-aws