2013-06-20 7 views
7

Sto usando Sphinx per documentare il mio pacchetto Python. Quando uso la direttiva automodule sul mio modulo:Come faccio a evitare che Sphinx ignori l'avviso GPL nella mia docstring?

.. automodule:: mymodule 
:members: 

viene stampato tutto, compreso il bando GPL nella docstring. C'è un modo per dire a Sphinx di ignorare la docstring/GPL o dovrei lasciarlo incluso nella documentazione?

+1

alcune idee 1) Non mettere licenza per ogni file (troppo prolisso in ogni caso) 2) commenti usare Python per licenza, non docstrings –

+0

La licenza GPL suggerisce fortemente/richiede l'una avviso di copyright (con riferimento ad un singolo file di licenza) essere incluso in ogni file sorgente ([vedi qui] (https://softwareengineering.stackexchange.com/a/125842/243280)). – ryanjdillon

risposta

9

Mi sono imbattuto nello stesso problema solo ora e l'ho risolto spostando l'avviso di licenza dalla docstring e in un blocco di commenti regolare nella parte superiore del file.

Ad esempio:

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

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...