2

假设我在 Python 模块中记录了一个变量，如下所示：

some_random_name = 'whatever'
"""The random whatever variable"""

我可以在我的 .rst 文件中包含该单个变量的自动文档，而无需拖入模块__doc__字符串并为此生成文档输出吗？

我努力了

.. automodule: themodule
   :members: some_random_name

但两者都__doc__拖入字符串并且不显示some_random_name.

4

1 回答 1

2

我无法重现记录模块属性的问题。这个对我有用。您的模块中是否有一个__all__变量的值不包括在内some_random_name？斯芬克斯 __all__在寻找成员时会考虑。

可以通过拦截autodoc-process-docstring事件来删除模块文档字符串。这是一个演示（将代码添加到conf.py）：

import inspect

def remove_mod_docstring(app, what, name, obj, options, lines):
    """Erase module docstring in-place"""  
    if inspect.ismodule(obj):
        for i in xrange(len(lines)):
            lines[i] = ''

def setup(app):
    app.connect('autodoc-process-docstring', remove_mod_docstring)
于 2013-01-22T22:23:16.093 回答