使用toctree的自动摘要还列出了导入的成员
使用toctree的自动摘要还列出了导入的成员
提问于 2014-08-20 12:46:06
我使用Sphinx和自动摘要生成Python软件的文档。它运行良好，但是生成的.rst文件也列出了导入的函数和类，这不是我想要的行为。
例如，带有docstring的包"packageex“：
"""
Package Example (:mod:`packageex`)
==================================
.. currentmodule:: packageex
.. autosummary::
:toctree:
module0
module1
"""将生成一个文件packageex.module0.rst
Module0 (:mod:`packageex.module0`)
=================================
.. currentmodule:: packageex.module0
.. rubric:: Functions
.. autosummary::
f0
f1
f2_imported
f3_imported
.. rubric:: Classes
.. autosummary::
Class0
ClassImported是否有一种方法只列出模块中定义的函数和类(而不是导入的函数和类)？
在autodoc (http://sphinx-doc.org/latest/ext/autodoc.html)的doc autodoc(http://sphinx-doc.org/latest/ext/autodoc.html)中，“在一个带有members选项集的automodule指令中，只有__module__属性等于给automodule的模块名的模块成员才会被文档化。这是为了防止导入类或函数的文档化。如果您想阻止这种行为并记录所有可用成员，请设置导入成员选项。注意，导入模块的属性不会被记录下来，因为属性文档是通过解析当前模块的源文件发现的。”使用自动摘要可以得到相同的行为吗？
回答 1
Stack Overflow用户
回答已采纳
发布于 2014-08-23 10:04:45
正如mzjn所提到的，它似乎是扩展自动摘要的一种已知的奇怪行为。为了获得想要的行为(即防止导入对象的列表)，我刚刚修改了函数get_members (sphinx.ext.autosummary.generate的1.166)如下：
def get_members(obj, typ, include_public=[], imported=False):
items = []
for name in dir(obj):
try:
obj_name = safe_getattr(obj, name)
documenter = get_documenter(obj_name, obj)
except AttributeError:
continue
if documenter.objtype == typ:
try:
cond = (
imported or
obj_name.__module__ == obj.__name__
)
except AttributeError:
cond = True
if cond:
items.append(name)
public = [x for x in items
if x in include_public or not x.startswith('_')]
return public, items页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/25405110
复制相关文章
相似问题
腾讯云开发者
