Python 使用twisted和Sphinx自动生成命令文档

我有一个项目，我使用buildout生成许多cmdline工具，使用Sphinx生成文档

---

有没有一种方法可以让我在cmdline代码定义附近编写文档，然后让Sphinx在一个页面中为所有命令生成文档，使用每个命令代码中的docstring？

部分解决方案是使用“autofunction”（请参阅）为代码编写文档。例如，对于

.rst

文件，如下所示：

Command line tools
==================

.. autofunction:: mypackage.tools.do_something
.. autofunction:: mypackage.importtasks.import
.. autofunction:: mypackage.feed_the_cat

这将像函数一样记录它们，这可能看起来不太好

另一个解决方案是自己从docstring生成一个适当的

.rst

文件。您可以将其生成到sphinx目录中并从那里使用它。作为一个例子，您可以查看一个工具集合（控制台脚本入口点，如您的，顺便说一句）和

---

基本上，您可以迭代一组文件，并将相关的

\uuuuu doc\uuuuu

项添加到文本文件中。我找不到如何使用

setuptools

或

pkginfo

从

setup.py

中获得

console\u脚本

条目，但如果需要自定义脚本，您可以这样做：-）

部分解决方案是使用“autofunction”（请参阅）来记录代码。例如，对于

.rst

文件，如下所示：

Command line tools
==================

.. autofunction:: mypackage.tools.do_something
.. autofunction:: mypackage.importtasks.import
.. autofunction:: mypackage.feed_the_cat

这将像函数一样记录它们，这可能看起来不太好

另一个解决方案是自己从docstring生成一个适当的

.rst

文件。您可以将其生成到sphinx目录中并从那里使用它。作为一个例子，您可以查看一个工具集合（控制台脚本入口点，如您的，顺便说一句）和

---

基本上，您可以迭代一组文件，并将相关的

\uuuuu doc\uuuuu

项添加到文本文件中。我找不到如何使用

setuptools

或

pkginfo

从

setup.py

中获得

console\u脚本

条目，但如果需要自定义脚本，您可以这样做：-）

通常，您可以使用autodoc sphinx扩展从docString创建文档。。。。不确定“生成cmdline工具”的确切含义是什么-您是在谈论代码生成吗？它们是在运行sphinx构建时定义的吗。我有一个用python构建的系统。它的入口点，即它从命令行提供的可供使用的命令，分散在代码中，然后我使用buildout创建调用这些函数的二进制文件。我想在一个地方收集所有这些函数的docstring，创建一个包含文档的命令列表。通常，您可以使用autodoc sphinx扩展从DocString创建文档。。。。不确定“生成cmdline工具”的确切含义是什么-您是在谈论代码生成吗？它们是在运行sphinx构建时定义的吗。我有一个用python构建的系统。它的入口点，即它从命令行提供的可供使用的命令，分散在代码中，然后我使用buildout创建调用这些函数的二进制文件。我想在一个地方收集所有这些函数的docstring，创建一个包含文档的命令列表。这是我想自动完成的。