Python Sphinx - autodoc和参数默认值

时间:2018-05-04 01:09:40

标签: python python-sphinx autoclass

我正在使用Sphinx来记录project I am working on。 我有一个类,我想使用autoclass::指令进行记录。

此类的__init__函数有一个默认参数,它是我模块中定义的变量,如下所示:def __init__(self, conn, config=default_client_config, request_timeout=1):

default_client_config是在项目的另一个文件中定义的字典。

生成类定义时,Sphinx显示变量的值,这使得签名难以阅读而不会给文档增加太多值。

enter image description here

我想保留default_client_config。这可以通过autodoc完成,还是应该进行手动定义?

0 个答案:

没有答案