【发布时间】：2022-06-13 14:17:01
【问题描述】：
我正在开发一个小型 python 3.10 库。我已经集成了 Sphinx 5.0 来记录项目功能、类、模块等。它在 ubuntu 容器上运行。该文档正在运行。让我困惑的一点是如何正确记录库多个入口点的使用？
更具体地说，在我的setup.cfg 中，我写了以下内容：
[options.entry_points]
console_scripts =
crumbs-fit-sdm = crumbs.sdm.fit:main
这样安装后用户可以在终端中输入例如crumbs-fit-sdm input -v，而无需找到.py 文件。
如何让 Sphinx 正确（并自动）记录此功能以及可用选项？
【问题讨论】：
-
您可以记录控制台脚本，但不能使用自动文档（如果您的意思是这样的话）。通过导入带有 autodoc 文档 modules 的 Sphinx。见stackoverflow.com/q/21003048/407651、stackoverflow.com/q/49179200/407651、stackoverflow.com/q/10886841/407651
-
这回答了我的问题，谢谢:)
标签： python documentation python-sphinx