怎么让Sphinx尊重使用__init__.py将类导入包

本教程将介绍如何让Sphinx尊重使用__init__.py将类导入包的处理方法,这篇教程是从别的地方看到的,然后加了一些国外程序员的疑问与解答,希望能对你有所帮助,好了,下面开始学习吧。

怎么让Sphinx尊重使用__init__.py将类导入包 教程 第1张

问题描述

我有一个包裹:

    foo

      foo.py

      bar.py

      __init__.py

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

from foo import Foo

Sphinx正确地将foo文档记录为foo.foo.foo,这是正确的,但会让用户感到困惑。怎么让Sphinx将其记录为foo.foo?

获取与正确模块关联的整个模块文档也很重要。

Sphinx文档名为:

..module:: module.name

但当我在foo.py文件的第一个注释中使用它时,该文档仍归属于foo.foo

推荐答案

__module__属性的值是在其中定义类/函数/方法的模块的名称(请参见https://docs.python.org/2.7/reference/datamodel.html)。该属性是可写的,因此可以在__init__.py:

中重新定义

Foo.__module__ = "foo"

现在如果使用.. automodule:: fooFoo类的限定名将在生成的模块文档中显示为foo.Foo


作为__module__小提琴的替代,您可以使用autoclass而不是automodule

将产生所需的输出。

好了关于怎么让Sphinx尊重使用__init__.py将类导入包的教程就到这里就结束了,希望趣模板源码网找到的这篇技术文章能帮助到大家,更多技术教程可以在站内搜索。