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

Question

I'm using Sphinx to document my Python package. When I use the automodule directive on my module:

.. automodule:: mymodule
:members:

It prints everything including the GPL notice in the docstring. Is there any way to tell Sphinx to ignore the docstring/GPL or should I leave it included in the documentation?

Answer 1

I ran into the same problem just now and fixed it by moving the license notice out of the docstring and into a regular comment block at the top of the file.

For example:

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

""" This is the module docstring.

Description of the module here.

Etc, etc.

"""

import ....
...