スフィンクス：

Question

をドキュメンテーション文字列からHTMLコンテンツではありませんコンテンツ更新Iは、Pythonを使ってNLP処理に使用するツールですセナとのインターフェースに上のプロジェクトに取り組んでいます。ドキュメントの生成を簡単にするために、私は非常に簡単なreStructuredTextドキュメントスタイルに従っていました。 2：WARNING：

はmake htmlを呼び出して、いくつかの時間（といつか警告なし）でpntl.tools.Annotator.testの

docstringのような警告が示されているフィールドリストが空白行せずに終了します。予期せぬアンインテンションともう1つのことは、この番号2の使用が作業中に表示されていることです。 built resultの

def test(senna_path="/media/jawahar/jon/ubuntu/senna", sent="", dep_model="", batch=False, 
      jar_path="/media/jawahar/jon/ubuntu/practNLPTools-lite/pntl"): 
    """please replace the path of yours environment(accouding to OS path) 
    :parama str senna_path: path for senna location 
    :parama str dep_model: stanford dependency parser model location 
    :parama str or list sent: the sentense to process with Senna 
    :parama bool batch: makeing as batch process with one or more sentense passing 
    :parama str jar_path: location of stanford-parser.jar file 
    """ 

や画像、HTMLの内容に誤りを表示するように取り付けられています。私のプロジェクトの詳細ビューについては、この後に従いますlink

Answer 1

このエラーは、構文やフィールドリストのまわりに空白行がないことを示します。インデントが正しくないことを示します。空白は重要です。

スペルも問題です。あなたはおそらく:param blah blah: thingを意味しません。:parama blah blah: thing:

詳細については、Info field listsを参照してください。

編集が

次の例では、問題を修正する必要があります。 "param"の正しい綴りと、docstringの記述からパラメータリストを分離するのに必要な改行に注意してください。さらに、コード内のPEP8警告を避けるために（reStructuredTextはこの場合は本当に気にしません）、メソッド定義にあるように長い行をラップする必要があります。 SphinxがPEP8の警告を避けるだけでなく、それを正しくレンダリングするように、パラメータリストに新しい行折り返しが追加されています。

def test(senna_path="/media/jawahar/jon/ubuntu/senna", sent="", dep_model="", 
     batch=False, 
     jar_path="/media/jawahar/jon/ubuntu/practNLPTools-lite/pntl"): 
    """ 
    please replace the path of yours environment(accouding to OS path) 

    :param str senna_path: path for senna location 
    :param str dep_model: stanford dependency parser model location 
    :param str or list sent: the sentense to process with Senna 
    :param bool batch: makeing as batch process with one or more sentense 
         passing 
    :param str jar_path: location of stanford-parser.jar file 
    """