本文介绍了带有toctree的自动汇总还会列出导入的成员的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！
问题描述
我使用Sphinx和autosumary来生成一个Python软件的文档。它工作得很好，但生成的.rst文件也列出了导入的函数和类，这不是我想要的行为。
例如带有文档字符串的包"Packageex"：
"""
Package Example (:mod:`packageex`)
==================================
.. currentmodule:: packageex
.. autosummary::
:toctree:
module0
module1
"""
将生成一个包含
的文件Packageex.mode0.rstModule0 (:mod:`packageex.module0`)
=================================
.. currentmodule:: packageex.module0
.. rubric:: Functions
.. autosummary::
f0
f1
f2_imported
f3_imported
.. rubric:: Classes
.. autosummary::
Class0
ClassImported
有没有办法只列出模块中定义的函数和类(而不列出导入的函数和类)？
http://sphinx-doc.org/latest/ext/autodoc.html在AutoDoc(http://sphinx-doc.org/latest/ext/autodoc.html)的文档中，设置了Members选项的自动模块指令中，只有__module__属性等于提供给自动模块的模块名称的模块成员才会被记录下来。这是为了防止记录导入的类或函数。如果您想要防止这种行为并记录所有可用的成员，请设置Imported-Members选项。请注意，不会记录来自导入模块的属性，因为属性文档是通过解析当前模块的源文件来发现的。是否可以使用自动摘要获得相同的行为？
推荐答案
正如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
这篇关于带有toctree的自动汇总还会列出导入的成员的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除！