2017-10-23 9 views
1

Sphinxスタイルのドキュメントストリングにハイライトまたはコードブロックを挿入するにはどうすればよいですか?例えば

def foo(): 
    ''' 
    .. highlight:: python 
    import sys 
    ''' 

は(それはそのまま単語「ハイライト」を印刷し、特別な方法で次のコードをフォーマットしない)は、所望の出力を生成しません。 code-blockでも同じです。

どのようなものであっても、ジェネレータはほぼ同じで出力は成功しますが、希望する出力は成功しません。

+1

インデントがありません。インポートラインの前に4つのスペースを追加してみてください。 – Vinny

+0

@Vinny明らかに、私も2つの間に空の線が必要です! – wvxvw

答えて

1

コードをdocsと比較すると、ハイライトと実際のコードの間にインデントと空白行がありません。これは次のようになります。

def foo(): 
    ''' 
    .. highlight:: python 
    .. code-block:: python 

     import sys 
     ... 
    ''' 
+0

これでは不十分です。コードはリテラルブロック(前の段落が '::'で終わるブロック)内になければなりません。 – mzjn

+0

私はそれを答えに追加しました、ありがとう! – Vinny

+0

編集後には機能しますが、冗長です。 '.. highlight :: python'は削除できます。 – mzjn

関連する問題