我有一个项目，我使用 buildout 生成许多命令行工具，并使用 Sphinx 生成文档。
有没有一种方法可以让我在 cmdline 的代码定义附近编写文档，然后让 Sphinx 在一页中为所有命令生成文档，使用每个命令的代码中的文档字符串？
请您参考如下方法:
部分解决方案是使用“自动功能”(参见 autodoc documentation)来记录您的代码。例如 .rst像这样的文件:
Command line tools
==================
.. autofunction:: mypackage.tools.do_something
.. autofunction:: mypackage.importtasks.import
.. autofunction:: mypackage.feed_the_cat
这会像函数一样记录它们，这可能看起来不太好。
另一个解决方案是生成一个合适的 .rst自己从文档字符串中获取文件。您可以将它生成到 sphinx 目录中并从那里使用它。作为示例，您可以查看 README.rst I generated对于工具集合(console_scripts 入口点，就像你的，顺便说一句)和 the script that generates the README .
您基本上遍历了一堆文件并添加了相关的 .__doc__项目到一个文本文件。我找不到如何使用 setuptools或 pkginfo得到我的手 console_scripts来自 setup.py 的条目，但如果需要，您可以在自定义脚本中执行此操作 :-)
