如何讓Sphinx忽略我的文檔字符串中的GPL通知？

Question

我正在使用Sphinx來記錄我的Python包。 當我在我的模塊上使用automodule指令時：

.. automodule:: mymodule
:members:

它會打印包括文檔字符串中的GPL通知在內的所有內容。 有沒有辦法告訴Sphinx忽略docstring / GPL還是應該把它留在文檔中？

Answer 1

我剛剛遇到了同樣的問題並通過將許可證通知移出文檔字符串並進入文件頂部的常規注釋塊來修復它。

例如：

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

""" This is the module docstring.

Description of the module here.

Etc, etc.

"""

import ....
...