相关疑难解决方法(0)

如何使Sphinx尊重使用__init__.py将类导入包中

我有一个包裹:

  • FOO
    • foo.py
    • bar.py
    • __init__.py

foo.py有一个Foo类.在__init__.py中我导入类Foo,以便用户可以执行以下操作:

from foo import Foo
Run Code Online (Sandbox Code Playgroud)

Sphinx正确地将Foo记录为foo.foo.Foo,这是正确的,但却让用户感到困惑.如何让Sphinx将其记录为foo.Foo?

获得与正确模块关联的整体模块文档也很重要.

Sphinx记录了一些名为:

..module:: module.name
Run Code Online (Sandbox Code Playgroud)

但是当我在foo.py文件的第一个评论中使用它时,文档仍然归于foo.foo.

python python-sphinx

9
推荐指数
1
解决办法
1566
查看次数

标签 统计

python ×1

python-sphinx ×1