使用 markdown 格式的强调语法

This commit is contained in:
hemengyang
2022-01-12 18:19:21 +08:00
parent 0099364838
commit 4ba1a09fb7
25 changed files with 536 additions and 536 deletions

View File

@ -56,8 +56,8 @@ class Driver(abc.ABC):
"""
:参数:
* ``env: Env``: 包含环境信息的 Env 对象
* ``config: Config``: 包含配置信息的 Config 对象
* `env: Env`: 包含环境信息的 Env 对象
* `config: Config`: 包含配置信息的 Config 对象
"""
self.env: str = env.environment
"""
@ -85,9 +85,9 @@ class Driver(abc.ABC):
:参数:
* ``name: str``: 适配器名称,用于在连接时进行识别
* ``adapter: Type[Bot]``: 适配器 Class
* ``**kwargs``: 其他传递给适配器的参数
* `name: str`: 适配器名称,用于在连接时进行识别
* `adapter: Type[Bot]`: 适配器 Class
* `**kwargs`: 其他传递给适配器的参数
"""
name = adapter.get_name()
if name in self._adapters:
@ -118,8 +118,8 @@ class Driver(abc.ABC):
启动驱动框架
:参数:
* ``*args``
* ``**kwargs``
* `*args`
* `**kwargs`
"""
logger.opt(colors=True).debug(
f"<g>Loaded adapters: {escape_tag(', '.join(self._adapters))}</g>"
@ -141,7 +141,7 @@ class Driver(abc.ABC):
:函数参数:
* ``bot: Bot``: 当前连接上的 Bot 对象
* `bot: Bot`: 当前连接上的 Bot 对象
"""
self._bot_connection_hook.add(func)
return func
@ -152,7 +152,7 @@ class Driver(abc.ABC):
:函数参数:
* ``bot: Bot``: 当前连接上的 Bot 对象
* `bot: Bot`: 当前连接上的 Bot 对象
"""
self._bot_disconnection_hook.add(func)
return func

View File

@ -27,7 +27,7 @@ class BlockDriver(Driver):
@property
@overrides(Driver)
def type(self) -> str:
"""驱动名称: ``block_driver``"""
"""驱动名称: `block_driver`"""
return "block_driver"
@property
@ -43,7 +43,7 @@ class BlockDriver(Driver):
:参数:
* ``func: Callable[[], Awaitable[None]]``
* `func: Callable[[], Awaitable[None]]`
"""
self.startup_funcs.add(func)
return func
@ -55,7 +55,7 @@ class BlockDriver(Driver):
:参数:
* ``func: Callable[[], Awaitable[None]]``
* `func: Callable[[], Awaitable[None]]`
"""
self.shutdown_funcs.add(func)
return func

View File

@ -48,19 +48,19 @@ class Config(BaseSettings):
fastapi_openapi_url: Optional[str] = None
"""
``openapi.json`` 地址,默认为 ``None`` 即关闭
`openapi.json` 地址,默认为 `None` 即关闭
"""
fastapi_docs_url: Optional[str] = None
"""
``swagger`` 地址,默认为 ``None`` 即关闭
`swagger` 地址,默认为 `None` 即关闭
"""
fastapi_redoc_url: Optional[str] = None
"""
``redoc`` 地址,默认为 ``None`` 即关闭
`redoc` 地址,默认为 `None` 即关闭
"""
fastapi_include_adapter_schema: bool = True
"""
是否包含适配器路由的 schema默认为 ``True``
是否包含适配器路由的 schema默认为 `True`
"""
fastapi_reload: bool = False
"""
@ -104,19 +104,19 @@ class Driver(ReverseDriver):
@property
@overrides(ReverseDriver)
def type(self) -> str:
"""驱动名称: ``fastapi``"""
"""驱动名称: `fastapi`"""
return "fastapi"
@property
@overrides(ReverseDriver)
def server_app(self) -> FastAPI:
"""``FastAPI APP`` 对象"""
"""`FastAPI APP` 对象"""
return self._server_app
@property
@overrides(ReverseDriver)
def asgi(self) -> FastAPI:
"""``FastAPI APP`` 对象"""
"""`FastAPI APP` 对象"""
return self._server_app
@property
@ -168,7 +168,7 @@ class Driver(ReverseDriver):
app: Optional[str] = None,
**kwargs,
):
"""使用 ``uvicorn`` 启动 FastAPI"""
"""使用 `uvicorn` 启动 FastAPI"""
super().run(host, port, app, **kwargs)
LOGGING_CONFIG = {
"version": 1,

View File

@ -94,19 +94,19 @@ class Driver(ReverseDriver):
@property
@overrides(ReverseDriver)
def type(self) -> str:
"""驱动名称: ``quart``"""
"""驱动名称: `quart`"""
return "quart"
@property
@overrides(ReverseDriver)
def server_app(self) -> Quart:
"""``Quart`` 对象"""
"""`Quart` 对象"""
return self._server_app
@property
@overrides(ReverseDriver)
def asgi(self):
"""``Quart`` 对象"""
"""`Quart` 对象"""
return self._server_app
@property
@ -161,7 +161,7 @@ class Driver(ReverseDriver):
app: Optional[str] = None,
**kwargs,
):
"""使用 ``uvicorn`` 启动 Quart"""
"""使用 `uvicorn` 启动 Quart"""
super().run(host, port, app, **kwargs)
LOGGING_CONFIG = {
"version": 1,