Python Sphinx-文档字符串文档显示不正确

时间:2018-07-05 05:43:29

标签: python python-3.x python-sphinx

我正在使用Python的Sphinx工具来记录我的代码。我为一个简单的项目创建了一个html。在我的文档字符串中,我对函数的变量使用了:param:type注释,但是Sphinx像这样在html中输出它们,这对读者来说有点难看并且非常不清楚:

https://i.stack.imgur.com/MY276.png

我尝试编辑“ conf.py”文件时没有运气。有没有办法更改Sphinx生成的html中的文档字符串输出?

谢谢!

编辑:这是“ say_hello_twice”功能的来源:

def say_hello_twice(a, b, c):
    """Random function
    :param a: string
    :param b: string
    :param c: string"""
    print('Hello Sphinx')
    print('Hello Sphinx')
    print(a + b + c)

当我包含:type时,输出保持不变。以上是一个示例。

0 个答案:

没有答案