How to preserve line breaks when generating python docs using sphinx

Saurabh Saxena picture Saurabh Saxena · Aug 11, 2011 · Viewed 38k times · Source

I am using Sphinx for generating docs for a python project. The output html is not preserving the line breaks which are present in the docstring. Example:

Code

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

Any idea how to fix it ?

Answer

Owen picture Owen · Aug 12, 2011

In general in restructured text use

| Vertical bars
| like this

to keep line breaks