gpt4 book ai didi

python - 在 autodoc 中排除模块文档字符串

转载 作者:太空狗 更新时间:2023-10-30 01:22:58 26 4
gpt4 key购买 nike

我正在尝试在 Sphinx 中使用 autodoc 打印出特定模块中每个函数的文档字符串,但不包括模块的文档字符串。可能吗?

原因是我正在使用模块文档字符串来指定命令行选项(使用可爱的 docopt)。

最佳答案

将以下内容添加到 conf.py:

def remove_module_docstring(app, what, name, obj, options, lines):
if what == "module" and name == "yourmodule":
del lines[:]

def setup(app):
app.connect("autodoc-process-docstring", remove_module_docstring)

此代码通过为 autodoc-process-docstring 提供处理程序来删除 yourmodule 模块中的模块文档字符串。事件。

关于python - 在 autodoc 中排除模块文档字符串,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17927741/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com