我正在使用狮身人面像生成文档。我遵循的文档字符串格式是NumPy样式的文档字符串。当它在浏览器上读取并呈现所有其他标题(参数,返回值,产量等)时,它不会呈现“属性”标题。我将“ sphinx_rtd_theme”用作html主题。
我尝试了以下方法:
1.在类文档字符串中使用padding: EdgeInsets.all(MediaQuery.of(context).size.width/10),
标题定义所有类属性。
2.在.rst文件中使用Attributes
,然后按照#:格式定义类属性。
autoattribute
预期结果-
class Demo:
"""Demo class.
Attributes
-----------
a : int
variable 1
b : int
variable 2
"""
def __init__(self, par1, par2):
"""Constructor.
Parameters
-----------
par1 : int
parameter 1
par2 : int
parameter 2
"""
self.a = par1
self.b = par2
实际结果-a和b呈现为标题而不是“属性”
Attributes(I want this as title)
- a(int) : variable 1
- b(int) : variable 2
它对于“参数”可正常使用,但对“属性”无效。我正在使用 sphinx 2.0.1