私のdocstringのGPL通知をSphinxが無視するようにするにはどうしたらいいですか？

Question

私はPythonパッケージを文書化するためにSphinxを使用しています。私は私のモジュールにautomoduleとディレクティブを使用する場合：

は

.. automodule:: mymodule 
:members: 

それはドキュメンテーション文字列でGPLの通知を含め、すべてを印刷します。 Sphinxにdocstring/GPLを無視するよう指示する方法はありますか？それを文書に残しておくべきですか？

Answer 1

私はまったく同じ問題に遭遇し、ライセンス通知をdocstringからファイルの先頭にある通常のコメントブロックに移動することで修正しました。例えば

：

# Copyright 2013 Example, inc. All rights reserved. 
# 
# License ... 
# ... 
# ... 

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...