使用Sphinx自动编制Python文档>> [

Question

这是previous question regarding Sphinx的广义版本。

是否有一种方法可以递归地自动文档化其中包含类和函数的模块或软件包？

我认为为每个函数添加autofunction或automodule指令是愚蠢的；必须有一种使过程自动化的方法，否则我根本看不到使用Sphinx的意义。

澄清：

代替：

.. automodule:: segments.segments

    .. autoclass:: segments.segments.Seg

        .. automethod:: Seg.method_1

        .. automethod:: Seg.method_2

        .. automethod:: Seg.method_3

        .......

        .. automethod:: Seg.method_n

这需要我手动剪切并粘贴所有方法名称并相应地更新文档，我想要一个类似这样的命令：

.. automodule:: segments.segments

    .. autoclass:: segments.segments.Seg

        .. MAGIC COMMAND: Automatically print the docstrings and signatures 
           of all Seg() methods.

[这是以前有关狮身人面像的问题的概括版本。有没有一种方法可以递归地自动在其中包含类和函数的模块或包进行自动文档编制？我认为是...

Answer 1

我们使用

Answer 2

为了使事情变得更容易，您可以使用以下脚本（查看页面底部的最新版本）：http://bitbucket.org/birkenfeld/sphinx/issue/98/add-the-autogenerate-script-to-sphinx

Answer 3

他在回答中提到的Etienne的脚本现已作为sphinx-apidoc集成到Sphinx中。它完全符合OP的要求。它计划在Sphinx 1.1中发布，或者可以从Hg存储库中获得：

Answer 4

我认为为每个功能添加自动功能或自动模块指令是愚蠢的；必须有一种使过程自动化的方法，否则我根本看不到使用Sphinx的意义。

Answer 5

您想要比指定自动模块更简单吗？即使对于大型库，键入所有模块名称也需要5分钟的工作。