2013-06-20 5 views
7

나는 나의 파이썬 패키지를 문서화하기 위해 스핑크스를 사용하고있다. 내 모듈에서 모듈 지시문을 사용할 때 :스핑크스에 docstring에서 GPL 통지를 무시하도록하려면 어떻게해야합니까?

.. automodule:: mymodule 
:members: 

이것은 GPL 통지를 포함한 모든 것을 문서화 문자열에 인쇄합니다. 스핑크스가 docstring/GPL을 무시하도록 지시 할 방법이 있습니까? 아니면 문서에 포함시켜야합니까?

+1

몇 가지 아이디어 라이센스 1) 어쨌든 너무 자세한 모든 파일 (에 라이센스를 넣지 마십시오) 2)를 사용하여 파이썬의 의견이 아닌 문서화 문자열 –

+0

GPL 라이센스 강하게 시사은 /는이 필요 저작권 표시 (단일 라이센스 파일 참조)가 각 소스 파일에 포함됩니다 ([여기를 참조하십시오] (https://softwareengineering.stackexchange.com/a/125842/243280)). – ryanjdillon

답변

9

지금 당장 같은 문제가 발생하여 라이센스 통지를 문서 문자열에서 파일 상단의 일반 주석 블록으로 옮겨서 문제를 해결했습니다. 예를 들어

는 :

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

""" This is the module docstring. 

Description of the module here. 

Etc, etc. 

""" 

import .... 
...