本文介绍了如何让Sphinx尊重使用__init__.py将类导入包的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！
问题描述
我有一个包裹：
- 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:: foo，Foo类的限定名将在生成的模块文档中显示为foo.Foo。
作为__module__小提琴的替代，您可以使用autoclass而不是automodule。
这篇关于如何让Sphinx尊重使用__init__.py将类导入包的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除！