You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/mkdocstrings_handlers/python/handler.py
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -181,6 +181,8 @@ class PythonHandler(BaseHandler):
181
181
merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
182
182
relative_crossrefs (bool): Whether to enable the relative crossref syntax. Default: `False`.
183
183
scoped_crossrefs (bool): Whether to enable the scoped crossref ability. Default: `False`.
184
+
docstring_inherit_strategy (str): The strategy to inherit docstrings of members from their implementation in parent classes. Options: `default`, `if_not_present`, `merge`. Default: `"default"`.
185
+
docstring_merge_delimiter (str): The delimiter used to merge docstrings, only applies when `docstring_inherit_strategy` is set to `merge`. Default: `"\n\n"`.
184
186
show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
185
187
show_docstring_attributes (bool): Whether to display the "Attributes" section in the object's docstring. Default: `True`.
186
188
show_docstring_functions (bool): Whether to display the "Functions" or "Methods" sections in the object's docstring. Default: `True`.
0 commit comments