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?
alcune idee 1) Non mettere licenza per ogni file (troppo prolisso in ogni caso) 2) commenti usare Python per licenza, non docstrings –
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