6

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考えているようです。.

4

1 に答える 1