plone / documentation

Plone Documentation
https://docs.plone.org
92 stars 154 forks source link

Consider adding sphinx-autodoc-typehints to requirements.txt #1168

Open stevepiercy opened 2 years ago

stevepiercy commented 2 years ago

@pauleveritt suggests the use of sphinx-autodoc-typehints to auto-document docstrings and typehints. In addition to the nice formatting, the return type of one class can be hyperlinked to another in the documentation.

See tutorial and updated code samples

pauleveritt commented 2 years ago

As a further point, it lessens the work as the docstring doesn't have to repeat type hint information for parameters.

stevepiercy commented 2 years ago

Of course, for this extension to be of any use, Plone code needs to use typehints. I have no idea if that has been or is being done.