Jak sprawić, by Sphinx zignorował ogłoszenie GPL w moim docstringu?

Question

Używam Sphinx do udokumentowania mojego pakietu Pythona. Kiedy używam dyrektywy o automatach w moim module:

.. automodule:: mymodule 
:members: 

Wyświetla wszystkie informacje, w tym notę ​​GPL w docstringu. Czy jest jakiś sposób, aby powiedzieć Sphinxowi, aby zignorował docstring/GPL, czy też powinienem zostawić to w dokumentacji?

Answer 1

Natknęłam się na ten sam problem i naprawiłam go, przenosząc notę ​​licencyjną z docstringu do zwykłego bloku komentarza na górze pliku.

Na przykład:

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

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...