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

Add sphinx-autodoc-typehints to sphinx docs generation #1566

Open
djhoese opened this issue Feb 24, 2021 · 0 comments
Open

Add sphinx-autodoc-typehints to sphinx docs generation #1566

djhoese opened this issue Feb 24, 2021 · 0 comments
Labels
cleanup Code cleanup but otherwise no change in functionality documentation

Comments

@djhoese
Copy link
Member

djhoese commented Feb 24, 2021

https://pypi.org/project/sphinx-autodoc-typehints/

The Satpy devs would like to start using type hinting, but this would end up having redundant information; type definitions in the docstring and type definitions in the annotations. This sphinx-autodoc-typehints extension would make it so we only need to do the type annotations and in the sphinx docs it will fill into the docstring information.

Main question is: can it handle doing this with some functions defining the docstring types and some doing the annotations or does it error out?

@djhoese djhoese added documentation cleanup Code cleanup but otherwise no change in functionality labels Feb 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code cleanup but otherwise no change in functionality documentation
Projects
None yet
Development

No branches or pull requests

1 participant