代码之家 › 专栏 › 技术社区 › Kernel

带sphinx新行的Python自动docstring

docstring python-sphinx python

0

Kernel · 技术社区 · 7 年前

我想知道,在使用Sphinx生成自动文档时,如何才能有一个新的行。我没有使用默认的Sphinx docstring格式structuredtext,而是使用Numpydoc格式。我试过使用“\n”但它会换行,我只需要一个新的行。下面是一个Python模块的示例。。。

""" This is the first sentences 
| this is the second sentence at line 2 ... note that vertical bar 
| this is the second sentence at line 3 ... note that vertical bar 
...... 
def function1 (input):
    """ this function docstring starts here
    | this is not sentence number 2 at the vertical bar is not working 
    | this is not sentence number 3 at the vertical bar is not working 
    | this is not sentence number 4 at the vertical bar is not working 
"""

1 回复 | 直到 6 年前

1

mzjn 7 年前

只需在第一行后添加一个空行:

def function1 (input):
    """ this function docstring starts here

    | this is not sentence number 2 at the vertical bar is not working 
    | this is not sentence number 3 at the vertical bar is not working 
    | this is not sentence number 4 at the vertical bar is not working 
    """

正文元素用空行分隔。docstring由两个body元素组成:regular paragraph 以及 line block

推荐文章

Mike T · 如何在Sphinx文档示例中获取旧版NumPy-repr?

1 年前

acbuyan · python 3.x sphinx如何在我的python包网站上添加动态过滤?

2 年前

mgilson · ..重新构造文本中的绘图指令

13 年前

mac · 有可能从Sphinx文档中生成一个.pot文件吗?

13 年前

codeape · 使用sphix网站支持:是否可以禁用对特定内容的评论?

13 年前