Skip to content

Commit c0e49cb

Browse files
committed
docs(kill_server): 更新事件文档的引用格式
- 将完整的模块路径引用改为相对引用格式 - 添加了 py:currentmodule 指令简化类引用 - 统一了文档中的类名显示方式 - 修复了文档格式化问题 fix(mcdrpost): 修正文档中的标记格式 - 修正了列表项中的特殊符号格式 - 确保文档渲染的一致性
1 parent edb9132 commit c0e49cb

3 files changed

Lines changed: 39 additions & 25 deletions

File tree

docs/source/kill_server/events.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
KillServer API -- Events
2-
=====================
2+
============================
3+
4+
.. py:currentmodule:: kill_server.events.server_event
35
46
KillServer 创建了一些新的事件用以监听服务器的运行状态.
57
对于 MCDR 内置的一些生命周期事件本插件继续沿用, 并补充了不少
6-
生命周期中的其他事件, 它们都是 :class:`kill_server.events.server_event.ServerEvent` 的实例
8+
生命周期中的其他事件, 它们都是 :class:`ServerEvent` 的实例
79

8-
.. autoclass:: kill_server.events.server_event.ServerEvent
10+
.. autoclass:: ServerEvent
911

1012
下面是 KillServer 创建的所有事件和 MCDR 服务端控制事件的集合类,
1113
在使用时, 推荐使用此类或直接使用事件 ID
1214

13-
.. autoclass:: kill_server.events.server_event.ServerEvents
15+
.. autoclass:: ServerEvents

docs/source/mcdrpost/custom_handler.rst

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,61 @@
11
MCDRpost API--自定义 Handler
22
============================
33

4+
.. py:currentmodule:: mcdrpost.api
5+
46
一般来说,MCDRpost已经能够适应大多数服务端,但是对于某些特殊情况(比如1.9版本) [#f1]_,MCDRpost可能无法满足需求,
57
考虑到插件对 Minecraft 的兼容性,插件暴露了一定的 API 用于 Minecraft 一些特殊服务端的适配
68

79
核心 API 有:
810

911
- classes
10-
- AbstractVersionHandler
11-
- AbstractSoundPlayer
12-
- DefaultVersionHandler
13-
- NewSoundPlayer
14-
- OldSoundPlayer
12+
- :class:`AbstractVersionHandler`
13+
- :class:`AbstractSoundPlayer`
14+
- :class:`DefaultVersionHandler`
15+
- :class:`NewSoundPlayer`
16+
- :class:`OldSoundPlayer`
1517
- functions
16-
- register_handler
18+
- :func:`register_handler`
1719
- types
18-
- Item
19-
- Environment
20+
- :class:`Item`
21+
- :class:`Environment`
2022
- constants
2123
- OFFHAND_CODE
2224

2325
你可以在导入的时候使用下面的方式:
2426

25-
.. code:: python
27+
.. code-block:: python
2628
2729
from mcdrpost.api import *
2830
2931
当然如果不希望污染全局变量也可以这样:
3032

31-
.. code:: python
33+
.. code-block:: python
3234
3335
from mcdrpost import api as mp
3436
3537
详细文档
3638
*********
3739

40+
处理器
41+
--------
42+
43+
.. autoclass:: AbstractVersionHandler
44+
.. autoclass:: DefaultVersionHandler
45+
.. autofunction:: register_handler
46+
47+
声音播放器
48+
----------
49+
50+
.. autoclass:: AbstractSoundPlayer
51+
.. autoclass:: NewSoundPlayer
52+
.. autoclass:: OldSoundPlayer
53+
54+
类型
55+
--------
3856

39-
.. autoclass:: mcdrpost.api.AbstractVersionHandler
40-
.. autoclass:: mcdrpost.api.DefaultVersionHandler
41-
.. autofunction:: mcdrpost.api.register_handler
42-
.. autoclass:: mcdrpost.api.AbstractSoundPlayer
43-
.. autoclass:: mcdrpost.api.NewSoundPlayer
44-
.. autoclass:: mcdrpost.api.OldSoundPlayer
45-
.. autoclass:: mcdrpost.api.Item
46-
.. autoclass:: mcdrpost.api.Environment
57+
.. autoclass:: Item
58+
.. autoclass:: Environment
4759

4860
示例
4961
-------
@@ -107,7 +119,7 @@ MCDRpost API--自定义 Handler
107119

108120
如果是用多文件插件的话,你甚至不需要定义 ``on_load``, 只需要在入口点内定义 Handler 并注册就好
109121

110-
example_handler/entry.py
122+
在 ``example_handler/entry.py`` 文件内
111123

112124
.. code:: python
113125
@@ -148,4 +160,4 @@ example_handler/entry.py
148160
149161
.. rubric:: 脚注
150162

151-
.. [#f1] 1.13 以前没有 ``/data`` 命令,要获取玩家物品需要在服务端安装插件,但 MCDR 主打的就是不修改服务端,所以本插件不考虑支持旧版
163+
.. [#f1] 1.13 以前没有 ``/data`` 命令,要获取玩家物品需要在服务端安装插件,但 MCDR 主打的就是不修改服务端,所以本插件不考虑主动支持旧版

docs/source/mcdrpost/readme.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ MCDRpost的配置文件(3.0.0或以上)在 ``config/MCDRpost/config.yml``
273273

274274
1. ``allow_alias`` ``command_prefixed`` 已经弃用并被合并到 ``prefix`` 内
275275
2. ``command_permission`` 改名为 ``permissions``
276-
3. ***【已落实】*** ``receive_tip_delay`` 改名为 ``receiving_tip_delay``
276+
3. `【已落实】` ``receive_tip_delay`` 改名为 ``receiving_tip_delay``
277277

278278
权限表
279279
^^^^^^^^^

0 commit comments

Comments
 (0)