怎么在使用SPHINX生成Python文档时保留换行符

本教程将介绍如何在使用SPHINX生成Python文档时保留换行符的处理方法,这篇教程是从别的地方看到的,然后加了一些国外程序员的疑问与解答,希望能对你有所帮助,好了,下面开始学习吧。

怎么在使用SPHINX生成Python文档时保留换行符 教程 第1张

问题描述

我正在使用Sphinx为一个python项目生成文档。
输出的html不会保留文档字符串中出现的换行符。
示例:

代码

def testMethod(arg1,arg2):
 """
 This is a test method

 Arguments:
 arg1: arg1 description
 arg2: arg2 description

 Returns:
 None
 """
 print "I am a test method"

Sphinx O/P:

TestModule.testMethod(arg1, arg2)

This is a test method

Arguments: arg1: arg1 description arg2: arg2 description

Returns: None

您知道怎么修复它吗?

推荐答案

通常在重构文本中使用

| Vertical bars
| like this

保留换行符

好了关于怎么在使用SPHINX生成Python文档时保留换行符的教程就到这里就结束了,希望趣模板源码网找到的这篇技术文章能帮助到大家,更多技术教程可以在站内搜索。