sopel-rtfm

当有人询问基本问题时，建议文档链接的插件。

功能

sopel-rtfm提供一条命令

• .rtfm — 在配置的Sphinx对象库存中搜索最佳匹配项，并输出其文档的链接。

配置

存在两个设置，其中一个为必需

[rtfm]
# Required: URL of the objects.inv file you want `.rtfm` to search
inventory = https://docs.project.site/objects.inv
# Optional, but useful if automatically determining the base URL doesn't work
link_base = https://docs.project.site/

需求

此插件是为Sopel 7.0+构建的，但仅针对Python 3.6+（无py2.7）。

此外，它需要来自PyPI的sphobjinv模块。

可选地，您可以安装sphobjinv[speedup]以实现更快的搜索；这取决于您的Python安装是否包含构建C扩展所需的依赖项。

0.4.0

新增

• .docs 命令别名，因为.rtfm感觉有点严厉（#2）

0.3.0

新增

• 为.rtfm命令提供适当的帮助输出（#1）

更改

• 在排序结果时优先考虑“更大”的对象类型
• 简化检索输出URL

0.2.0

新增

• 缓存行为：配置的Sphinx库存在启动时获取，并自动每24小时重新获取一次
• 机器人管理员可以使用新的.rtfmupdate命令强制更新

0.1.1

更改

• 空/缺失查询现在输出文档的基本URL而不是错误

修复

• 在shutdown()后，rtfm_base被留在bot.memory中

0.1.0

初始版本。