python - sphinx.ext.autodoc : Keeping names of constants in signature

Question

我正在使用 Sphinx 的自动文档功能来记录我的 API。

例子:

DEFAULT_OPTION = 'default'
def do_something(msg, option=DEFAULT_OPTION):
    print msg

生成的文档现在显示以下签名:

do_something(msg, option='default')

我如何告诉 Sphinx 保留常量值的名称，即

do_something(msg, option=DEFAULT_OPTION)

?

有没有我忽略的选项？如果可能的话，我不想再手写所有签名。

Answer 1

自 Sphinx 4.0 版以来，有一个新的配置选项 ( autodoc_preserve_defaults )。设置

autodoc_preserve_defaults = True

在您的 conf.py 中将保留源代码中的默认值。