From 5c70476310aa9002be0090191d72cbe6a385d416 Mon Sep 17 00:00:00 2001 From: Nick Papior Date: Fri, 11 Oct 2024 15:45:51 +0200 Subject: [PATCH] fixed documentation so Parameters won't show up twice Signed-off-by: Nick Papior --- docs/conf.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e2bce49fed..7575477d89 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -236,6 +236,10 @@ # is basically groupwise. So lets be explicit autodoc_member_order = "groupwise" +# Show type-hints in both the signature +# and in the variable list +autodoc_typehints = "signature" + # typehints only shows the minimal class, instead # of full module paths # The linkage is still problematic, and a known issue: @@ -243,10 +247,9 @@ # autodoc will likely get a rewrite. Until then.. autodoc_typehints_format = "short" -# Show type-hints in both the signature -# and in the variable list -autodoc_typehints = "both" -autodoc_typehints_description_target = "all" +# Do not evaluate things that are defaulted in arguments. +# Show them *as-is*. +autodoc_preserve_defaults = True # Automatically create the autodoc_type_aliases # This is handy for commonly used terminologies.