2013-06-20 28 views
7

Python paketimi belgelemek için Sphinx kullanıyorum. Benim modülünde automodule yönergesini kullandığınızda:Sfenks'imi GPL bildirimi göz ardı etmek için nasıl kullanırım?

.. automodule:: mymodule 
:members: 

O docstringe içinde GPL ibaresinin bulunması her şeyi yazdırır. Sfenks'e doktora/GPL'yi görmezden gelmenin bir yolu var mı, yoksa belgeye dahil edilmeli mi?

+1

bazı fikirler lisans için 1) zaten çok ayrıntılı her dosya (lisans koymayın) 2) Kullanım Python yorum, değil Docstringler –

+0

GPL lisansı kuvvetle düşündürmektedir/a gerektirir Her kaynak dosyaya telif hakkı bildirimi (tek bir lisans dosyasına referansla) dahil edilmelidir ((bkz. https://softwareengineering.stackexchange.com/a/125842/243280)). – ryanjdillon

cevap

9

Sadece şu anda aynı sorunla karşılaştım ve lisans bildirimini dokümanın dışına taşıyarak ve dosyanın en üstündeki normal bir yorum bloğuna getirdim. Örneğin

:

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

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...