スフィンクスを使用してpythonドキュメントを生成するときに改行を保存する方法

Question

私はPythonプロジェクトのドキュメントを生成するためにSphinxを使用しています。 出力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" 

スフィンクスO/P：

TestModule.testMethod(arg1, arg2) 

This is a test method 

Arguments: arg1: arg1 description arg2: arg2 description 

Returns: None 

それを修正するためにどのように任意のアイデア？再編テキストで一般的に

Answer 1

私の特定のケースでは

Answer 2

を改行を維持するために

| Vertical bars 
| like this 

を使用し、私はドキュメンテーション文字列（""" my doc string """）を読むためにautodocのを取得しようとしていました。あなたがメインの.rstファイルに以下を追加した場合

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

Answer 3

：：私はどこでも私は改行を追加するために必要な\nを使用して終了

.. |br| raw:: html 

    <br /> 

次に、あなたのマークアップであなたがに|br|に追加することができますHTMLのためだけに改行を作成してください。

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

から：http://docutils.sourceforge.net/FAQ.html#how-to-indicate-a-line-break-or-a-significant-newlineあなたが書くことができますあなたの場合は

Answer 4

：

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 5

この答えが遅れて来たが、多分それはまだ他の人に役立つことでしょう。

reStructuredTextをドキュメントストリングに使用できます。これは、しかし、あなたがドキュメンテーション文字列（http://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments）のためのGoogleのスタイルを使用しているようで、あなたの例のルックスから

:param arg1: arg1 description 
:type arg1: str 
:param arg2: arg2 description 
:type arg2: str 

ようになります。

スフィンクスはそれらをネイティブにサポートしていません。しかし、napoleonという拡張子があり、GoogleとNumpyスタイルのdocstringsをhttps://pypi.python.org/pypi/sphinxcontrib-napoleonで解析します。

あなたはそれが必要な

extensions = [                 
'sphinx.ext.autodoc',              
'sphinxcontrib.napoleon',             
'sphinx.ext.doctest',                            
]