Python sphinx 为什么Sphinx不自动记录模块变量?
我希望有模块变量的自动文档,但它不起作用。文档中缺少所有变量。。。如何修复此问题,以便autodoc将列出每个模块变量 mypackage/\uuuu init\uuuuu.py:Python sphinx 为什么Sphinx不自动记录模块变量?,python-sphinx,autodoc,Python Sphinx,Autodoc,我希望有模块变量的自动文档,但它不起作用。文档中缺少所有变量。。。如何修复此问题,以便autodoc将列出每个模块变量 mypackage/\uuuu init\uuuuu.py: class __init__: test = 'test' _test = '_test' __test = '__test' __test__ = '__test__' __author__ = 'author' __email__ = 'author_email' __descr
class __init__:
test = 'test'
_test = '_test'
__test = '__test'
__test__ = '__test__'
__author__ = 'author'
__email__ = 'author_email'
__description__ = 'description'
__version__ = 'version'
和文档图像:
使用
:特殊成员:
.. autoclass:: my.Class
:members:
:private-members:
:special-members:
根据Python最佳实践,下划线表示的模块被视为内部模块,我想autodoc默认情况下不会记录它们。您可以查看Sphinx文档中的选项,或者显式设置
\uuuuu all\uuuu
,以告知您正在导出哪些模块变量。我尝试过,但没有成功。我认为这是一个bug…我已经准备好在conf.py文件中这样做了autodoc\u default\u flags=['members'、'special-members'、'private-members'、'undoc-members']
因为我看到了类privates和specijal,所以我知道这一切就绪都可以工作,但不适用于模块privates。。。可能存在python版本差异?