1. Anuncie Aqui ! Entre em contato fdantas@4each.com.br

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

Discussão em 'Python' iniciado por Stack, Outubro 4, 2024 às 07:42.

  1. Stack

    Stack Membro Participativo

    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 ?

    Continue reading...

Compartilhe esta Página