首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >Sphinx,使用automodule查找子模块

Sphinx,使用automodule查找子模块
EN

Stack Overflow用户
提问于 2012-07-17 00:12:42
回答 1查看 23.6K关注 0票数 34

当使用斯芬克斯的自动模块(https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)时,

我只是在一个.rst文件中写道:

代码语言:javascript
复制
.. automodule:: my_module
    :members:

它很好地记录了my_module,但是找不到像my_module.inner_module0和my_module.inner_module1这样的内部模块。除了__all__变量之外,还需要在__init__.py文件中指定什么内容吗?

另外,我知道sphinx-apidoc。但是该命令文档太多(暴露了每个函数/文件夹,包括未记录的函数/文件夹)。

EN

回答 1

Stack Overflow用户

发布于 2017-03-27 18:31:40

在我看来,如果__init__.py导入这些子模块,using the :imported-members: option (非直接链接,使用搜索)现在应该是可能的。

然而,我个人(目前)还不能做到这一点。

编辑:可能是known bug

票数 5
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/11508290

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档