📝 update doc

nonebot/adapters/cqhttp/config.py

@@ -5,6 +5,14 @@ from pydantic import Field, BaseModel
 
 # priority: alias > origin
 class Config(BaseModel):
+    """
+    CQHTTP 配置类
+
+    :配置项:
+
+      - ``access_token`` / ``cqhttp_access_token``: CQHTTP 协议授权令牌
+      - ``secret`` / ``cqhttp_secret``: CQHTTP HTTP 上报数据签名口令
+    """
     access_token: Optional[str] = Field(default=None,
                                         alias="cqhttp_access_token")
     secret: Optional[str] = Field(default=None, alias="cqhttp_secret")

nonebot/adapters/ding/config.py

@@ -4,6 +4,14 @@ from pydantic import Field, BaseModel
 
 
 class Config(BaseModel):
+    """
+    钉钉配置类
+
+    :配置项:
+
+      - ``access_token`` / ``ding_access_token``: 钉钉令牌
+      - ``secret`` / ``ding_secret``: 钉钉 HTTP 上报数据签名口令
+    """
     secret: Optional[str] = Field(default=None, alias="ding_secret")
     access_token: Optional[str] = Field(default=None, alias="ding_access_token")
 

nonebot/adapters/mirai/config.py

@@ -10,9 +10,9 @@ class Config(BaseModel):
 
     :必填:
 
-      - ``mirai_auth_key``: mirai-api-http的auth_key
-      - ``mirai_host``: mirai-api-http的地址
-      - ``mirai_port``: mirai-api-http的端口
+      - ``auth_key`` / ``mirai_auth_key``: mirai-api-http 的 auth_key
+      - ``mirai_host``: mirai-api-http 的地址
+      - ``mirai_port``: mirai-api-http 的端口
     """
     auth_key: Optional[str] = Field(None, alias='mirai_auth_key')
     host: Optional[IPv4Address] = Field(None, alias='mirai_host')

nonebot/drivers/__init__.py

@@ -62,7 +62,7 @@ class Driver(abc.ABC):
         :说明: 已连接的 Bot
         """
 
-    def register_adapter(self, name: str, adapter: Type["Bot"]):
+    def register_adapter(self, name: str, adapter: Type["Bot"], **kwargs):
         """
         :说明:
 
@@ -74,7 +74,7 @@ class Driver(abc.ABC):
           * ``adapter: Type[Bot]``: 适配器 Class
         """
         self._adapters[name] = adapter
-        adapter.register(self, self.config)
+        adapter.register(self, self.config, **kwargs)
         logger.opt(
             colors=True).debug(f'Succeeded to load adapter "<y>{name}</y>"')
 

nonebot/drivers/fastapi.py

@@ -28,9 +28,39 @@ from nonebot.drivers import Driver as BaseDriver, WebSocket as BaseWebSocket
 
 
 class Config(BaseSettings):
+    """
+    FastAPI 驱动框架设置，详情参考 FastAPI 文档
+    """
     fastapi_openapi_url: Optional[str] = None
+    """
+    :类型:
+
+      ``Optional[str]``
+
+    :说明:
+
+      `openapi.json` 地址，默认为 `None` 即关闭
+    """
     fastapi_docs_url: Optional[str] = None
+    """
+    :类型:
+
+      ``Optional[str]``
+
+    :说明:
+
+      `swagger` 地址，默认为 `None` 即关闭
+    """
     fastapi_redoc_url: Optional[str] = None
+    """
+    :类型:
+
+      ``Optional[str]``
+
+    :说明:
+
+      `redoc` 地址，默认为 `None` 即关闭
+    """
 
     class Config:
         extra = "ignore"