gpt4 book ai didi

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

转载 作者:行者123 更新时间:2023-12-03 16:07:01 25 4
gpt4 key购买 nike

有没有办法用 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正在考虑最后 . 之前的任何事情作为包和模块。

最佳答案

尝试:
.. autoclass:: package.module::A.B
来源:https://groups.google.com/forum/#!topic/sphinx-users/IL5V7HR1ZYE

关于python - 如何使用 Sphinx 的 autodoc 记录嵌套类?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27337534/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com