如何使用 Sphinx 的 autodoc 记录嵌套类?

eep*_*epp 6 python inner-classes python-3.x python-sphinx autodoc

有没有办法用 Sphinx 的 autodoc 插件记录嵌套类?

在:

class A:
    class B:
    """
    class B's documentation.
    """

    # ...
Run Code Online (Sandbox Code Playgroud)

我想autoclass在我的.rst文件中使用或类似的东西来A.B专门记录。

我试过:

.. currentmodule:: package.module

.. autoclass:: A.B
Run Code Online (Sandbox Code Playgroud)

.. autoclass:: package.module.A.B
Run Code Online (Sandbox Code Playgroud)

没有成功:

/path/to/file.rst:280: WARNING: autodoc: failed to import class 'B' from module 'package.module.A'; the following exception was raised:

...

Traceback (most recent call last):
  File "/usr/lib/python3.4/site-packages/sphinx/ext/autodoc.py", line 335, in import_object
    __import__(self.modname)
ImportError: No module named 'package.module.A'; 'package.module' is not a package
Run Code Online (Sandbox Code Playgroud)

当然A不是模块;似乎autoclass正在考虑.作为包和模块之前的任何东西。

Eth*_*nig 7

尝试:

.. autoclass:: package.module::A.B

来源:https : //groups.google.com/forum/#!topic/sphinx- users/ IL5V7HR1ZYE