Comment conserver les sauts de ligne lors de la génération de documents python à l'aide de sphinx

Question

J'utilise Sphinx pour générer des documents pour un projet python. La sortie html ne préserve pas les sauts de ligne présents dans la docstring. Exemple:

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

Toute idée de comment résoudre ce problème ?

Answer 1

En général dans l'utilisation de texte restructuré

 | Vertical bars
| like this

garder les sauts de ligne

Answer 2

Si vous ajoutez les éléments suivants à votre fichier .rst principal :

 .. |br| raw:: html

   <br />

Ensuite, dans votre balisage, vous pouvez ajouter |br| pour créer des sauts de ligne uniquement pour le HTML.

 I want to break this line here: |br| after the break.

De : http://docutils.sourceforge.net/FAQ.html#how-to-indicate-a-line-break-or-a-significant-newline

Answer 3

Dans votre cas, vous pouvez écrire :

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

  | Arguments:
  | arg1: arg1 description
  | arg2: arg2 description

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

Answer 4

Dans mon cas particulier, j'essayais de faire en sorte que autodoc lise une chaîne doc ( """ my doc string """ ). J'ai fini par utiliser \n partout où j'avais besoin d'ajouter un saut de ligne :

 This is the first line\n
and this is the second line\n