如何从automodapi输出中排除导入?

时间:2017-11-17 06:22:20

标签: python python-sphinx astropy

我正在尝试使用automodapi为我的Django项目生成文档。当我这样打电话给automodapi时:

.. automodapi:: mypackage.mymodule

输出包括所有导入的类和函数,例如Django Model类,在函数和类的索引中。我想排除导入,只列出我指定的模块中声明的那些类和函数。

我在文档中看不到任何相关内容。

有没有办法做到这一点,最好不修改模块?

更新:@saimn使用__all__提供了有效的解决方案,但我的项目并未使用__all__。如果有一个解决方案不涉及修改模块,那就太好了。

1 个答案:

答案 0 :(得分:1)

您可以使用__all__变量(这可能应该在文档中更清楚地说明。)