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

私はPythonパッケージを文書化するためにSphinxを使用しています。私は私のモジュールにautomoduleとディレクティブを使用する場合：私のdocstringのGPL通知をSphinxが無視するようにするにはどうしたらいいですか？

は

.. automodule:: mymodule 
:members:

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

出典

2013-06-20 tompreston

いくつかのアイデア1）とにかく、あまりにも冗長（すべてのファイルにライセンスを入れないでください）ライセンスの2）を使用するPythonのコメントではなく、ドキュメンテーション文字列 –

GPLライセンスが強く示唆/ Aが必要です各ソースファイルには著作権表示（単一のライセンスファイルを参照）が含まれています（[こちらを参照]（https://softwareengineering.stackexchange.com/a/125842/243280））。 – ryanjdillon

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

：

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

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...

出典

2013-08-08 10:09:11

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

答えて

関連する問題