栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

是否可以覆盖Sphinx autodoc的特定功能?

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

是否可以覆盖Sphinx autodoc的特定功能?

可以使用

autofunction
以下方法覆盖签名:

.. automodule:: yourmodule   :members:   :exclude-members: funcname.. autofunction:: funcname(arg1[, arg2[, ...]])

但是,具有覆盖签名的函数不会与通过引入的其他函数进行排序

automodule
autofunction
对每个函数使用显式指令可以解决此问题:

.. autofunction:: firstfunc.. autofunction:: funcname(arg1[, arg2[, ...]]).. autofunction:: thirdfunc

加成

您还可以附加到文档字符串:

.. autofunction:: funcname(arg1[, arg2[, ...]])   Extra documentation here.

要覆盖签名和文档字符串,请使用

function
代替
autofunction

加法2

也可以通过将签名作为函数docstring的第一行来覆盖签名。有关详细信息,请参见此答案。



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/652719.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号