如何使用sphinx autodoc和分离模块并避免噪音?

时间:2014-07-30 19:03:32

标签: python python-sphinx

http://sphinx-doc.org/domains.html#directive-py:module谈及modulecurrentmodule。它们看起来像我想要的。

我所拥有的目录是x/y,其中包含__init__.py__init__.py有类似的内容:

from y import *
from y2 import *

换句话说,我希望消费者只做

import something from x.y

并且不知道或不关心我如何将代码划分为源文件x/y/ybase.pyx/y/y2.py。 (如果有人关心,有些代码是自动生成的,那就是我希望它分裂的原因。)

此食谱可在http://chimera.labs.oreilly.com/books/1230000000393/ch10.html#modulesplitting中找到。

所以在我看来好像我想要.. module::x.y__init__.py .. currentmodule:x.y 在每个.py文件中。

这是有效的,但结果仍然是关于x.y.y,我希望他们只讨论x.y.我该如何解决?

autodoc扩展程序有:imported-members:,但遗漏了所有属性doc是一个非常严重的限制。

0 个答案:

没有答案