狮身人面像：记录python库的入口点（控制台脚本）
我正在开发一个小的Python 3.10库。我已经集成了Sphinx 5.0来记录项目功能，类，模块等。这在Ubuntu容器上运行。文档正在起作用。让我感到困惑的观点是如何正确记录库多个入口点的使用？
更具体地说，在我的setup.cfg中，我写了以下内容：
[options.entry_points]
console_scripts =
crumbs-fit-sdm = crumbs.sdm.fit:main
以便在安装后，用户可以在终端中输入EG crumbs-fit-sdm input -v要找到.py文件。
如何使Sphinx正确（并自动）记录此功能以及可用选项？
I am developing a small python 3.10 library. I have integrated Sphinx 5.0 to document the project functions, classes, modules etc. This runs on a ubuntu container. The documentation is working. The point that confuses me is how to properly document the use of the library multiple entrypoints?
More specifically, in my setup.cfg, I wrote the following:
[options.entry_points]
console_scripts =
crumbs-fit-sdm = crumbs.sdm.fit:main
So that after installation the user can type in the terminal eg crumbs-fit-sdm input -v without having to locate the .py file.
How to have Sphinx properly (and automatically) document this feature along with the available options?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论