add typing docs

docs/api/config.md

@@ -6,6 +6,11 @@
 基类：`pydantic.env_settings.BaseSettings`
 
 
+### _class_ `Env(_env_file='<objectobject>', _env_file_encoding=None, *, environment='prod')`
+
+基类：`pydantic.env_settings.BaseSettings`
+
+
 ### _class_ `Config(_env_file='<objectobject>', _env_file_encoding=None, *, driver='nonebot.drivers.fastapi', host=IPv4Address('127.0.0.1'), port=8080, secret=None, debug=False, api_root={}, api_timeout=60.0, access_token=None, superusers={}, nickname='', command_start={'/'}, command_sep={'.'}, session_expire_timeout=datetime.timedelta(seconds=120), **values)`
 
 基类：[`nonebot.config.BaseConfig`](#nonebot.config.BaseConfig)
@@ -25,8 +30,3 @@ configs:
 
 * 说明:
 nonebot 运行使用后端框架封装 Driver 。继承自 nonebot.driver.BaseDriver 。
-
-
-### _class_ `Env(_env_file='<objectobject>', _env_file_encoding=None, *, environment='prod')`
-
-基类：`pydantic.env_settings.BaseSettings`

docs/api/nonebot.md

@@ -1,6 +1,37 @@
 # NoneBot 模块
 
 
+### `get_driver()`
+
+
+* **说明**
+
+    获取全局 Driver 对象。可用于在计划任务的回调中获取当前 Driver 对象。
+
+
+
+* **返回**
+
+    
+    * `Driver`: 全局 Driver 对象
+
+
+
+* **异常**
+
+    
+    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
+
+
+
+* **用法**
+
+
+```python
+driver = nonebot.get_driver()
+```
+
+
 ### `get_app()`
 
 
@@ -94,37 +125,6 @@ bots = nonebot.get_bots()
 ```
 
 
-### `get_driver()`
-
-
-* **说明**
-
-    获取全局 Driver 对象。可用于在计划任务的回调中获取当前 Driver 对象。
-
-
-
-* **返回**
-
-    
-    * `Driver`: 全局 Driver 对象
-
-
-
-* **异常**
-
-    
-    * `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
-
-
-
-* **用法**
-
-
-```python
-driver = nonebot.get_driver()
-```
-
-
 ### `init(*, _env_file=None, **kwargs)`
 
 

docs/api/typing.md

@@ -9,23 +9,6 @@
 以下类型均可从 nonebot.typing 模块导入。
 
 
-### `Bot`
-
-
-* **类型**
-
-    BaseBot
-
-
-
-* **说明**
-
-    所有 Bot 的基类。
-
-
-alias of TypeVar('Bot')
-
-
 ### `Driver`
 
 
@@ -40,75 +23,6 @@ alias of TypeVar('Bot')
     所有 Driver 的基类。
 
 
-alias of TypeVar('Driver')
-
-
-### `Event`
-
-
-* **类型**
-
-    BaseEvent
-
-
-
-* **说明**
-
-    所有 Event 的基类。
-
-
-alias of TypeVar('Event')
-
-
-### `Message`
-
-
-* **类型**
-
-    BaseMessage
-
-
-
-* **说明**
-
-    所有 Message 的基类。
-
-
-alias of TypeVar('Message')
-
-
-### `MessageSegment`
-
-
-* **类型**
-
-    BaseMessageSegment
-
-
-
-* **说明**
-
-    所有 MessageSegment 的基类。
-
-
-alias of TypeVar('MessageSegment')
-
-
-### `PreProcessor`
-
-
-* **类型**
-
-    Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]
-
-
-
-* **说明**
-
-    消息预处理函数 PreProcessor 类型
-
-
-alias of Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]
 
 
 ### `WebSocket`
@@ -125,4 +39,193 @@ alias of Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]
     所有 WebSocket 的基类。
 
 
-alias of TypeVar('WebSocket')
+
+
+### `Bot`
+
+
+* **类型**
+
+    BaseBot
+
+
+
+* **说明**
+
+    所有 Bot 的基类。
+
+
+
+
+### `Event`
+
+
+* **类型**
+
+    BaseEvent
+
+
+
+* **说明**
+
+    所有 Event 的基类。
+
+
+
+
+### `Message`
+
+
+* **类型**
+
+    BaseMessage
+
+
+
+* **说明**
+
+    所有 Message 的基类。
+
+
+
+
+### `MessageSegment`
+
+
+* **类型**
+
+    BaseMessageSegment
+
+
+
+* **说明**
+
+    所有 MessageSegment 的基类。
+
+
+
+
+### `PreProcessor`
+
+
+* **类型**
+
+    Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]
+
+
+
+* **说明**
+
+    消息预处理函数 PreProcessor 类型
+
+
+
+
+### `Matcher`
+
+
+* **类型**
+
+    Matcher
+
+
+
+* **说明**
+
+    Matcher 即响应事件的处理类。通过 Rule 判断是否响应事件，运行 Handler。
+
+
+
+
+### `Rule`
+
+
+* **类型**
+
+    Rule
+
+
+
+* **说明**
+
+    Rule 即判断是否响应事件的处理类。内部存储 RuleChecker ，返回全为 True 则响应事件。
+
+
+
+
+### `RuleChecker`
+
+
+* **类型**
+
+    Callable[[Bot, Event, dict], Awaitable[bool]]
+
+
+
+* **说明**
+
+    RuleChecker 即判断是否响应事件的处理函数。
+
+
+
+
+### `Permission`
+
+
+* **类型**
+
+    Permission
+
+
+
+* **说明**
+
+    Permission 即判断是否响应消息的处理类。内部存储 PermissionChecker ，返回只要有一个 True 则响应消息。
+
+
+
+
+### `PermissionChecker`
+
+
+* **类型**
+
+    Callable[[Bot, Event], Awaitable[bool]]
+
+
+
+* **说明**
+
+    RuleChecker 即判断是否响应消息的处理函数。
+
+
+
+
+### `Handler`
+
+
+* **类型**
+
+    Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]
+
+
+
+* **说明**
+
+    Handler 即事件的处理函数。
+
+
+
+
+### `ArgsParser`
+
+
+* **类型**
+
+    Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]
+
+
+
+* **说明**
+
+    ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。

docs_build/conf.py

@@ -70,6 +70,9 @@ html_static_path = ['_static']
 
 # -- Extension configuration -------------------------------------------------
 
+# -- Options for autodoc extension ----------------------------------------------
+autodoc_default_options = {'member-order': 'bysource'}
+
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.

nonebot/typing.py

@@ -105,11 +105,60 @@ PreProcessor = Callable[[Bot, Event, dict], Union[Awaitable[None],
 """
 
 Matcher = TypeVar("Matcher", bound="MatcherClass")
+"""
+:类型: `Matcher`
+
+:说明:
+
+  Matcher 即响应事件的处理类。通过 Rule 判断是否响应事件，运行 Handler。
+"""
+Rule = TypeVar("Rule", bound="RuleClass")
+"""
+:类型: `Rule`
+
+:说明:
+
+  Rule 即判断是否响应事件的处理类。内部存储 RuleChecker ，返回全为 True 则响应事件。
+"""
+RuleChecker = Callable[[Bot, Event, dict], Awaitable[bool]]
+"""
+:类型: `Callable[[Bot, Event, dict], Awaitable[bool]]`
+
+:说明:
+
+  RuleChecker 即判断是否响应事件的处理函数。
+"""
+Permission = TypeVar("Permission", bound="PermissionClass")
+"""
+:类型: `Permission`
+
+:说明:
+
+  Permission 即判断是否响应消息的处理类。内部存储 PermissionChecker ，返回只要有一个 True 则响应消息。
+"""
+PermissionChecker = Callable[[Bot, Event], Awaitable[bool]]
+"""
+:类型: `Callable[[Bot, Event], Awaitable[bool]]`
+
+:说明:
+
+  RuleChecker 即判断是否响应消息的处理函数。
+"""
 Handler = Callable[[Bot, Event, dict], Union[Awaitable[None],
                                              Awaitable[NoReturn]]]
-Rule = TypeVar("Rule", bound="RuleClass")
+"""
-RuleChecker = Callable[[Bot, Event, dict], Awaitable[bool]]
+:类型: `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
-Permission = TypeVar("Permission", bound="PermissionClass")
+
-PermissionChecker = Callable[[Bot, Event], Awaitable[bool]]
+:说明:
+
+  Handler 即事件的处理函数。
+"""
 ArgsParser = Callable[[Bot, Event, dict], Union[Awaitable[None],
                                                 Awaitable[NoReturn]]]
+"""
+:类型: `Callable[[Bot, Event, dict], Union[Awaitable[None], Awaitable[NoReturn]]]`
+
+:说明:
+
+  ArgsParser 即消息参数解析函数，在 Matcher.got 获取参数时被运行。
+"""

poetry.lock

@@ -600,7 +600,7 @@ unify = "*"
 yapf = "*"
 
 [package.source]
-reference = "b7ca9332c2e4c5e50110d6477dd28821c74da778"
+reference = "85ffe5c872e0ad57bfd1b5432d49e03a2f900a8f"
 type = "git"
 url = "https://github.com/nonebot/sphinx-markdown-builder.git"
 [[package]]