Skip to content

Commit

Permalink
refactor: Disable show_submodules by default
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed May 8, 2022
1 parent 312a709 commit 480d0c3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/mkdocstrings_handlers/python/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class PythonHandler(BaseHandler):
"merge_init_into_class": False,
"show_source": True,
"show_bases": True,
"show_submodules": True,
"show_submodules": False,
"group_by_category": True,
"heading_level": 2,
"members_order": rendering.Order.alphabetical.value,
Expand All @@ -90,7 +90,7 @@ class PythonHandler(BaseHandler):
filters (list[str] | None): A list of filters applied to filter objects based on their name.
A filter starting with `!` will exclude matching objects instead of including them. Default: `["!^_[^_]"]`.
group_by_category (bool): Group the object's children by categories: attributes, classes, functions, and modules. Default: `True`.
show_submodules (bool): When rendering a module, show its submodules recursively. Default: `True`.
show_submodules (bool): When rendering a module, show its submodules recursively. Default: `False`.
Attributes: Docstrings options:
docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`.
Expand Down

0 comments on commit 480d0c3

Please sign in to comment.