我目前正在处理我的项目的文档,并且发现了sphinx的autoclass指令的问题。我想写一个实例属性的描述。
class Aclass():
'''Class description'''
param1 = 'abcde'
param2 = '12345'
def something(self):
...
我试图用以下代码生成此代码的文档:
.. autoclass:: Aclass
:members:
在输出中列出参数和功能。对于参数我想扩展描述,我不知道如何。到目前为止,参数转换如下:
Parameters: param1 (str) - Param1
param2 (int) - Param2
我想要更改的部分是Param1和Param2。
到目前为止,我试图在代码的文档中添加一个描述来覆盖自动生成的结果。
class Aclass():
'''Class description
:param str param1: Some description regarding param1.
:param int param2: Description of param2.
'''
param1 = 'abcde'
param2 = '12345'
def something(self):
这只是说明中参数的两倍。
Parameters: param1 (str) - Some description regarding param1.
param2 (int) - Description of param2.
param1 (str) - Param1
param2 (int) - Param2
目标是仅保留参数描述的上面两行。