Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
st1020 committed Mar 26, 2024
1 parent 7d9d463 commit 69b58b3
Show file tree
Hide file tree
Showing 39 changed files with 530 additions and 557 deletions.
2 changes: 1 addition & 1 deletion docs/api/adapter/apscheduler/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ APScheduler 配置类,将在适配器被加载时被混入到机器人主配

- **scheduler\_config** (_Dict\[str, Any\]_) - 调度器配置。

### _method_ `__init__(self, /, **data)` {#BaseModel.\_\_init\_\_}
### _method_ `__init__(self, /, **data)` {#BaseModel---init--}

Create a new model by parsing and validating input data from keyword arguments.

Expand Down
8 changes: 4 additions & 4 deletions docs/api/adapter/apscheduler/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ APSchedulerEvent 事件基类。

- **plugin\_class** (_Type\[alicebot.plugin.Plugin\]_)

### _method_ `__init__(self, /, **data)` {#BaseModel.\_\_init\_\_}
### _method_ `__init__(self, /, **data)` {#BaseModel---init--}

Create a new model by parsing and validating input data from keyword arguments.

Expand All @@ -31,19 +31,19 @@ validated to form a valid model.

Type: _None_

### _readonly property_ `job` {#APSchedulerEvent.job}
### _readonly property_ `job` {#APSchedulerEvent-job}

Type: _apscheduler.job.Job_

产生当前事件的 APScheduler `Job` 对象。

### _readonly property_ `trigger` {#APSchedulerEvent.trigger}
### _readonly property_ `trigger` {#APSchedulerEvent-trigger}

Type: _Union\[str, apscheduler.triggers.base.BaseTrigger, NoneType\]_

当前事件对应的 Plugin 的 `trigger`

### _readonly property_ `trigger_args` {#APSchedulerEvent.trigger\_args}
### _readonly property_ `trigger_args` {#APSchedulerEvent-trigger-args}

Type: _Optional\[Dict\[str, Any\]\]_

Expand Down
16 changes: 8 additions & 8 deletions docs/api/adapter/apscheduler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ APScheduler 配置类,将在适配器被加载时被混入到机器人主配

- **scheduler\_config** (_Dict\[str, Any\]_) - 调度器配置。

#### _method_ `__init__(self, /, **data)` {#BaseModel.\_\_init\_\_}
#### _method_ `__init__(self, /, **data)` {#BaseModel---init--}

Create a new model by parsing and validating input data from keyword arguments.

Expand All @@ -46,7 +46,7 @@ validated to form a valid model.

Type: _None_

### _method_ `__init__(self, bot)` {#Adapter.\_\_init\_\_}
### _method_ `__init__(self, bot)` {#Adapter---init--}

初始化。

Expand All @@ -58,7 +58,7 @@ validated to form a valid model.

Type: _None_

### _async method_ `create_event(self, plugin_class)` {#APSchedulerAdapter.create\_event}
### _async method_ `create_event(self, plugin_class)` {#APSchedulerAdapter-create-event}

创建 `APSchedulerEvent` 事件。

Expand All @@ -70,15 +70,15 @@ validated to form a valid model.

Type: _None_

### _async method_ `run(self)` {#APSchedulerAdapter.run}
### _async method_ `run(self)` {#APSchedulerAdapter-run}

启动调度器。

- **Returns**

Type: _None_

### _async method_ `send(self, *args, **kwargs)` {#APSchedulerAdapter.send}
### _async method_ `send(self, *args, **kwargs)` {#APSchedulerAdapter-send}

APScheduler 适配器不适用发送消息。

Expand All @@ -92,23 +92,23 @@ APScheduler 适配器不适用发送消息。

Type: _Any_

### _async method_ `shutdown(self)` {#APSchedulerAdapter.shutdown}
### _async method_ `shutdown(self)` {#APSchedulerAdapter-shutdown}

关闭调度器。

- **Returns**

Type: _None_

### _async method_ `startup(self)` {#APSchedulerAdapter.startup}
### _async method_ `startup(self)` {#APSchedulerAdapter-startup}

创建 `AsyncIOScheduler` 对象。

- **Returns**

Type: _None_

## _function_ `scheduler_decorator(trigger, trigger_args, override_rule = False)` {#scheduler\_decorator}
## _function_ `scheduler_decorator(trigger, trigger_args, override_rule = False)` {#scheduler-decorator}

用于为插件类添加计划任务功能的装饰器。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/adapter/cqhttp/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ CQHTTP 配置类,将在适配器被加载时被混入到机器人主配置中

- **access\_token** (_str_) - 鉴权。

### _method_ `__init__(self, /, **data)` {#BaseModel.\_\_init\_\_}
### _method_ `__init__(self, /, **data)` {#BaseModel---init--}

Create a new model by parsing and validating input data from keyword arguments.

Expand Down
Loading

0 comments on commit 69b58b3

Please sign in to comment.