Update docs

This commit is contained in:
Changhua 2023-07-15 12:13:40 +08:00
parent 6feb9c33b8
commit 8b70fafdc0
4 changed files with 18 additions and 4 deletions

View File

@ -28,10 +28,24 @@ def main():
wcf = Wcf(args.wcf_host, args.wcf_port, args.wcf_debug) wcf = Wcf(args.wcf_host, args.wcf_port, args.wcf_debug)
home = "https://github.com/lich0821/WeChatFerry" home = "https://github.com/lich0821/WeChatFerry"
qrcodes = """<table>
<thead>
<tr>
<th style="text-align:center"><img src="https://raw.githubusercontent.com/lich0821/WeChatFerry/master/assets/TEQuant.jpg" alt="碲矿"></th>
<th style="text-align:center"><img src="https://raw.githubusercontent.com/lich0821/WeChatFerry/master/assets/QR.jpeg" alt="赞赏"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">后台回复 <code>WeChatFerry</code> 加群交流</td>
<td style="text-align:center">如果你觉得有用</td>
</tr>
</tbody>
</table>"""
http = Http(wcf=wcf, http = Http(wcf=wcf,
cb=cb, cb=cb,
title="WeChatFerry HTTP 客户端", title="WeChatFerry HTTP 客户端",
description=f"Github: <a href='{home}'>WeChatFerry</a>",) description=f"Github: <a href='{home}'>WeChatFerry</a>{qrcodes}",)
uvicorn.run(app=http, host=args.host, port=args.port) uvicorn.run(app=http, host=args.host, port=args.port)

View File

@ -234,7 +234,7 @@ class Wcf():
"""发送文本消息 """发送文本消息
Args: Args:
msg (str): 要发送的消息换行使用 `\\n`如果 @ 人的话需要带上跟 `aters` 里数量相同的 @ msg (str): 要发送的消息换行使用 `\\\\n` 单杠如果 @ 人的话需要带上跟 `aters` 里数量相同的 @
receiver (str): 消息接收人wxid 或者 roomid receiver (str): 消息接收人wxid 或者 roomid
aters (str): @ wxid多个用逗号分隔`@所有人` 只需要 `notify@all` aters (str): @ wxid多个用逗号分隔`@所有人` 只需要 `notify@all`

File diff suppressed because one or more lines are too long

View File

@ -53,6 +53,6 @@ myst_enable_extensions = ["linkify", "colon_fence"]
# Document Python Code # Document Python Code
autoapi_type = "python" autoapi_type = "python"
autoapi_dirs = ["../../python/wcferry"] autoapi_dirs = ["../../clients/python/wcferry"]
autoapi_member_order = "groupwise" autoapi_member_order = "groupwise"
autoapi_options = ["members", "undoc-members", "show-inheritance", "show-module-summary", "imported-members"] autoapi_options = ["members", "undoc-members", "show-inheritance", "show-module-summary", "imported-members"]