Python – How to preserve line breaks when generating python docs using sphinx

pythonpython-sphinx

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 ?

Best Answer

In general in restructured text use

| Vertical bars
| like this

to keep line breaks

Related Solutions

Python – How to do a line break (line continuation) in Python

What is the line? You can just have arguments on the next line without any problems:

a = dostuff(blahblah1, blahblah2, blahblah3, blahblah4, blahblah5, 
            blahblah6, blahblah7)

Otherwise you can do something like this:

if (a == True and
    b == False):

or with explicit line break:

if a == True and \
   b == False:

Check the style guide for more information.

Using parentheses, your example can be written over multiple lines:

a = ('1' + '2' + '3' +
    '4' + '5')

The same effect can be obtained using explicit line break:

a = '1' + '2' + '3' + \
    '4' + '5'

Note that the style guide says that using the implicit continuation with parentheses is preferred, but in this particular case just adding parentheses around your expression is probably the wrong way to go.

Python – How to get line count of a large file cheaply in Python

One line, probably pretty fast:

num_lines = sum(1 for line in open('myfile.txt'))

Best Answer

Related Solutions

Python – How to do a line break (line continuation) in Python

Python – How to get line count of a large file cheaply in Python

Related Topic