web-dev-qa-db-ja.com

コードドキュメントの生成時に予期しないインデント警告の原因を取り除く方法は？

問題のあるドキュメンテーションコードはメソッドの最初にあります：

"""
Gtk.EventBox::button-release-event signal handler.
:param widget: The clicked widget (The Gtk.EventBox).
:param event: Gdk.EventButton object with information regarding
       the event.
:param user_data: The Gtk.LinkButton that should be opened when
       the Gtk.EventBox is clicked.
:return: None
"""

警告は次のとおりです。

C:/msys64/home/hope/python+gtk/test/main.py:docstring of main.Builder.advertisem
ent_clicked:4: WARNING: Unexpected indentation.
C:/msys64/home/hope/python+gtk/test/main.py:docstring of main.Builder.advertisem
ent_clicked:5: WARNING: Block quote ends without a blank line; unexpected uninde
nt.

これらの警告とその原因を取り除くために何ができますか？

python-2.7windows-10python-sphinxrestructuredtextmsys2
10
silviubogan

メソッドの概要の説明の後、パラメーターの説明の前に空白行を追加するだけです。

"""
Gtk.EventBox::button-release-event signal handler.

:param widget: The clicked widget (The Gtk.EventBox).
:param event: Gdk.EventButton object with information regarding
       the event.
:param user_data: The Gtk.LinkButton that should be opened when
       the Gtk.EventBox is clicked.
:return: None
"""

ここ このアドバイスを見つけることができます：

「予期しないインデント」というSphinxビルドエラーが発生した場合、それはおそらく、Sphinxがリテラルテキストブロックの後などの空白行を予期しているためです。あなたのラインはSphinxを包んで混乱させたかもしれません。この場合、テキストがウィンドウのマージンを超えても、テキストを前の行まで引き上げてみてください。または、Enterを押して次の行に移動することもできますが、必ず新しい行のテキストをインデントしてください。

13
silviubogan