docs: Update docs

Author: pawamoy

docs/css/mkdocstrings.css

@@ -1,8 +1,7 @@
 /* Indentation. */
 div.doc-contents:not(.first) {
  padding-left: 25px;
- border-left: 4px solid rgba(230, 230, 230);
- margin-bottom: 80px;
+ border-left: .05rem solid var(--md-typeset-table-color);
 }
 
 /* Mark external links as such */

docs/usage.md

@@ -41,7 +41,7 @@ Option | Description
 
 ### Rendering
 
-::: mkdocstrings_handlers.python.renderer.PythonRenderer.default_config
+::: mkdocstrings_handlers.python.handler.PythonHandler.default_rendering_config
  rendering:
  show_root_toc_entry: false
 
@@ -162,8 +162,7 @@ Here are some CSS rules for the
 /* Indentation. */
 div.doc-contents:not(.first) {
  padding-left: 25px;
- border-left: .05rem solid var(--md-default-fg-color--lightest);
- margin-bottom: 80px;
+ border-left: .05rem solid var(--md-typeset-table-color);
 }
 ```
 

src/mkdocstrings_handlers/python/handler.py

@@ -74,29 +74,27 @@ class PythonHandler(BaseHandler):
  "members_order": rendering.Order.alphabetical.value,
  "docstring_section_style": "table",
  }
- """The default rendering options.
-
- Option | Type | Description | Default
- ------ | ---- | ----------- | -------
- **`show_root_heading`** | `bool` | Show the heading of the object at the root of the documentation tree. | `False`
- **`show_root_toc_entry`** | `bool` | If the root heading is not shown, at least add a ToC entry for it. | `True`
- **`show_root_full_path`** | `bool` | Show the full Python path for the root object heading. | `True`
- **`show_object_full_path`** | `bool` | Show the full Python path of every object. | `False`
- **`show_root_members_full_path`** | `bool` | Show the full Python path of objects that are children of the root object (for example, classes in a module). When False, `show_object_full_path` overrides. | `False`
- **`show_category_heading`** | `bool` | When grouped by categories, show a heading for each category. | `False`
- **`show_if_no_docstring`** | `bool` | Show the object heading even if it has no docstring or children with docstrings. | `False`
- **`show_signature`** | `bool` | Show method and function signatures. | `True`
- **`show_signature_annotations`** | `bool` | Show the type annotations in method and function signatures. | `False`
- **`separate_signature`** | `bool` | Whether to put the whole signature in a code block below the heading. | `False`
- **`line_length`** | `int` | Maximum line length when formatting code. | `60`
- **`merge_init_into_class`** | `bool` | Whether to merge the `__init__` method into the class' signature and docstring. | `False`
- **`show_source`** | `bool` | Show the source code of this object. | `True`
- **`show_bases`** | `bool` | Show the base classes of a class. | `True`
- **`show_submodules`** | `bool` | When rendering a module, show its submodules recursively. | `True`
- **`group_by_category`** | `bool` | Group the object's children by categories: attributes, classes, functions, methods, and modules. | `True`
- **`heading_level`** | `int` | The initial heading level to use. | `2`
- **`members_order`** | `str` | The members ordering to use. Options: `alphabetical` - order by the members names, `source` - order members as they appear in the source file. | `alphabetical`
- **`docstring_section_style`** | `str` | The style used to render docstring sections. Options: `table`, `list`, `spacy`. | `table`
+ """
+ Attributes: Default rendering options:
+ show_root_heading (bool): Show the heading of the object at the root of the documentation tree. Default: `False`.
+ show_root_toc_entry (bool): If the root heading is not shown, at least add a ToC entry for it. Default: `True`.
+ show_root_full_path (bool): Show the full Python path for the root object heading. Default: `True`.
+ show_root_members_full_path (bool): Show the full Python path of every object. Default: `False`.
+ show_object_full_path (bool): Show the full Python path of objects that are children of the root object (for example, classes in a module). When False, `show_object_full_path` overrides. Default: `False`.
+ show_category_heading (bool): When grouped by categories, show a heading for each category. Default: `False`.
+ show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
+ show_signature (bool): Show method and function signatures. Default: `True`.
+ show_signature_annotations (bool): Show the type annotations in method and function signatures. Default: `False`.
+ separate_signature (bool): Whether to put the whole signature in a code block below the heading. Default: `False`.
+ line_length (int): Maximum line length when formatting code. Default: `60`.
+ merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
+ show_source (bool): Show the source code of this object. Default: `True`.
+ show_bases (bool): Show the base classes of a class. Default: `True`.
+ show_submodules (bool): When rendering a module, show its submodules recursively. Default: `True`.
+ group_by_category (bool): Group the object's children by categories: attributes, classes, functions, methods, and modules. Default: `True`.
+ heading_level (int): The initial heading level to use. Default: `2`.
+ members_order (str): The members ordering to use. Options: `alphabetical` - order by the members names, `source` - order members as they appear in the source file. Default: `alphabetical`.
+ docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `table`.
  """ # noqa: E501
 
  def __init__(self, *args, **kwargs) -> None: