From 7c792e96c68c0308ca7d6b913dd9fc82cf727012 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Fri, 5 Mar 2021 22:22:53 -0300 Subject: [PATCH] Add type annotations to the description instead of signature This configures Sphinx autodoc to include the type annotations along with the description of the function/method, instead of including it into the signature. Fix #8405 --- doc/en/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/en/conf.py b/doc/en/conf.py index e34ae6856..d9c1f3c2d 100644 --- a/doc/en/conf.py +++ b/doc/en/conf.py @@ -35,6 +35,7 @@ release = ".".join(version.split(".")[:2]) # sys.path.insert(0, os.path.abspath('.')) autodoc_member_order = "bysource" +autodoc_typehints = "description" todo_include_todos = 1 # -- General configuration -----------------------------------------------------