狮身人面像autodoc不够自动

问题:

我正在使用Sphinx在Python中记录5000多行项目。它有大约7个基本模块。据我所知,为了使用autodoc,我需要为我的项目中的每个文件编写这样的代码:

.. automodule:: mods.set.tests
    :members:
    :show-inheritance:

这太麻烦了,因为我有很多文件。这将会更容易,如果我可以指定我想要的’mods’包被记录。然后,Sphinx可以递归地遍历包,并为每个子模块创建一个页面。
有这样的功能吗?如果不是,我可以编写一个脚本来创建所有的.rst文件,但这会占用很多时间。

回答:

您可以查看我所做的script。我认为它可以帮助你。
该脚本解析目录树,寻找python模块和软件包,并适当地创建ReST文件以使用Sphinx创建代码文档。它还创建一个模块索引。
 UPDATE
此脚本现在是Sphinx 1.1的一部分,为apidoc

 
 
Code问答: http://codewenda.com/topics/python/
Stackoverflow: Sphinx autodoc is not automatic enough

*转载请注明本文链接以及stackoverflow的英文链接

发表评论

电子邮件地址不会被公开。 必填项已用*标注

49 + = 55