Question

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

在：

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

    # ...

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

我试过了：

.. currentmodule:: package.module

.. autoclass:: A.B

和

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

没有成功：

/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

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

Answer 1

尝试：

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

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

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

1 个答案: