为什么Sphinx没有autodoc模块变量?

时间:2015-08-01 16:11:30

标签: python-sphinx autodoc

我想拥有模块变量的自动文档,但它不起作用。文档中缺少所有变量...如何修复此问题,因此autodoc将列出每个模块变量?

mypackage的/ __初始化__吡啶

class __init__:
    test = 'test'
    _test = '_test'
    __test = '__test'
    __test__ = '__test__'

__author__ = 'author'
__email__ = 'author_email'
__description__ = 'description'
__version__ = 'version'

和docs形象:

enter image description here

1 个答案:

答案 0 :(得分:0)

使用:special-members:

.. autoclass:: my.Class
   :members:
   :private-members:
   :special-members:

http://sphinx-doc.org/ext/autodoc.html