스핑크스에서는 모듈에 있지만 모듈과 클래스에있는 문서 문자열/주석을 포함하는 방법

Question

내 패키지에 utils 모듈이 있습니다. 인스턴스화를 필요로하지 않는 몇 가지 기타 독립형 메소드로 구성됩니다.

나는 등,이 utils 파일 내부에 문서화 문자열/몇 가지 일반적인 의견을 배치 할 :

위에서 볼 수 있듯이

import os 
import json 

""" 
Miscellaneous methods that help in <<blah blah>> 
Does not require explicit instantiation. 

The following actions can be performed: 
=============== =============== 
Action   Method 
=============== =============== 
Get a    :meth:`methoda` 
Get b    :meth:`methodb` 
""" 

def methoda(data): 
    "Gets A ..." 
    ... 

def methodb(data): 
    "Gets B ..." 
    ... 

는 문서화 문자열은 각각의 방법에 대한 링크를 포함하는 테이블을 가지고있다. 현재 내 index.rst이 utils 포함하려면이 부분이 있습니다 : 현재

Utilities 
============ 
.. automodule:: packagename.utils 
    :members: 

를, 내가 어떤 클래스의 외부 (적절 문서에 표시되는 각각의 방법의 문서화 문자열 아닌 모듈의 최상위 문서화 문자열을 얻거나 방법). 스핑크스를 가지고있는 가장 좋은 방법은 무엇입니까?

하나의 옵션은 최상위 문서 문자열을 index.rst 등과 같이이 파일 외부로 이동할 수 있습니다.하지만이 작업을 수행하지 않고 원본 파일 내에서 유지하는 것이 좋습니다.

Answer 1

jonsharpe에게 감사의 말을 전하고 적절한 방법으로 안내해주었습니다.

""" 
Miscellaneous methods that help in <<blah blah>> 
Does not require explicit instantiation. 

The following actions can be performed: 
=============== =============== 
Action   Method 
=============== =============== 
Get a    :meth:`methoda` 
Get b    :meth:`methodb` 
""" 

import os 
import json 

def methoda(data): 
    "Gets A ..." 
    ... 

def methodb(data): 
    "Gets B ..." 
    ... 

을 그리고 그것 뿐이다 : 다른 사람이 나중에 참조 할 수 있도록

, 나는 기본적으로 파일의 시작에 문서화 문자열을 이동! 모든 것이 작동합니다.