如何使用Sphinx的autodoc文档嵌套类？

问题描述

有什么方法可以使用Sphinx的autodoc插件来记录嵌套类？

Is there any way to document a nested class with Sphinx's autodoc plugin?

在：

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

    # ...

我想使用 autoclass 或我的 .rst 文件中的某些内容专门用于记录 AB 。

I want to use autoclass or something similar in my .rst file to document A.B specifically.

我尝试过：

.. 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 正在考虑最后一个之前的任何事情。作为软件包和模块。

Of course A is not a module; it seems like autoclass is considering anything before the last . as packages and modules.

推荐答案

尝试：

.. autoclass :: package.module :: AB

来源：

这篇关于如何使用Sphinx的autodoc文档嵌套类？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！