Skip to content

Commit

Permalink
fixed documentation so Parameters won't show up twice
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <[email protected]>
  • Loading branch information
zerothi committed Oct 11, 2024
1 parent e3f3214 commit 5c70476
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,17 +236,20 @@
# 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:
# https://github.com/sphinx-doc/sphinx/issues/10455
# 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.
Expand Down

0 comments on commit 5c70476

Please sign in to comment.