Skip to content

Generate documentation from typing indicators #230

@ocaballeror

Description

@ocaballeror

When we move to typing for the next release, we should also find some system to generate documentation based on those indicators. That would allow us to clean up some docstrings that only have a "Returns" section to indicate the return type.

This Sphinx extension looks like it could do the job, but I haven't looked much into it:
https://github.com/agronholm/sphinx-autodoc-typehints

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions