Updates documentation and doc generation parameters

dynamixelmotorsapi/dynamixelmotors.py

@@ -1,3 +1,17 @@
+"""
+[DynamixelMotorsAPI](https://github.com/SofaComplianceRobotics/DynamixelMotorsAPI) is a Python API 
+to control Dynamixel motors, supporting heterogeneous motor groups where each motor can be a 
+different series with different conversion parameters.
+
+To install the API, run:
+```bash
+pip install https://github.com/SofaComplianceRobotics/DynamixelMotorsAPI@main
+```
+
+The motor group is configured via a list of MotorConfig objects, one per motor, which can be loaded from a dict or JSON file.
+
+"""
+
 from threading import Lock
 from math import pi
 from typing import List

pyproject.toml

@@ -44,7 +44,7 @@ type = "python"
 type = "filter"
 skip_empty_modules = true
 exclude_private = true
-expression = "not name.startswith('_') and '_' not in obj.location.filename and default()"
+expression = "not name.startswith('_') and '_' not in obj.location.filename and default() and 'scraper' not in name"
 
 [[tool.pydoc-markdown.processors]]
 type="smart"
@@ -55,7 +55,7 @@ type="crossref"
 [tool.pydoc-markdown.renderer]
 type = "markdown"
 filename = "dynamixelmotors-api.md"
-descriptive_class_title = false
+descriptive_class_title = "$ Class"
 descriptive_module_title = false
 render_page_title = true
 render_module_header = false
@@ -64,7 +64,7 @@ add_full_prefix = false
 insert_header_anchors = false
 classdef_code_block = true
 signature_code_block = true
-signature_in_header = true
+signature_in_header = false
 code_headers = false
 use_fixed_header_levels = true
 render_toc = false