파이썬 pydoc이

내가 init.py 에서 파이썬 패키지를 문서화하기 위해 노력하고있어 그것이하여 pydoc을 통해 사용자에게 표시하기 위해 "" "트리플 괄호" ""코멘트를 구문 분석하는 방법을 나에게 불분명 :파이썬 pydoc이

>>> help(package)

또는
$ pydoc package

어떻게 의견은 pydoc이 출력의 이름 및 설명 섹션에서 콘텐츠를 제공하기 위해 구문 분석? 예와 같이 내가 채울 수있는 다른 섹션이 있습니까?

출처

2016-09-08 sdruser

의이 더미 패키지 생각해 보자 : ./whatever/__init__.py에

./whatever 
├── __init__.py 
├── nothing 
│   └── __init__.py 
└── something.py

을 우리는 가지고 :

""" 
This is whatever help info. 

This is whatever description 

EXAMPLES: 
    ... 
""" 

__version__ = '1.0' 

variable = 'variable'

이제 실행 파이썬 쉘 :

➜ ~ python 
Python 2.7.12 (default, Jul 1 2016, 15:12:24) 
[GCC 5.4.0 20160609] on linux2 
Type "help", "copyright", "credits" or "license" for more information. 
>>> import whatever 
>>> help(whatever)

출력은 다음과 같습니다

설명 섹션에 제공 할 수있는 예입니다. 그래서 ./whatever/__init__.py.

희망이 있습니다.

출처

2016-09-08 15:20:37 turkus

첫 번째 줄에는 짧은 설명 (예 : PEP 257에 설명 된 한 줄을 초과해서는 안 됨)이 포함되어 있으며 이름 뒤에 표시됩니다. 빈 줄과 단락 다음에 설명 섹션에 내용을 제공하는 데 사용됩니다.

그래서, 예를 들어 당신은 (모듈로 간단한 예) just_to_see/__init__.py이있는 경우 :

"""A short description 

A longer description on several lines etc. 
blablabla etc.""" 

def a_function(): 
    """ 
    An interesting introductive comment. 

    Some more explanations. 
    """ 
    pass

(here을 언급 한 바와 같이 문서화 문자열이하는 __doc__ 속성처럼 다른 곳이 될 수 있습니다)

다음 pydoc3.4 just_to_see/__init__.py 출력 :

Help on module __init__: 

NAME 
    __init__ - A short description 

DESCRIPTION 
    A longer description on several lines etc. 
    blablabla etc. 

FUNCTIONS 
    a_function() 
     An interesting introductive comment. 

     Some more explanations. 

FILE 
    /home/nico/temp/just_to_see/__init__.py

패키지는 가상 싸다에 (설치되어있는 경우 예를 들어) pydoc에서 더 많은 정보를 찾을 수 있습니다 (작성자 이름 등). setup.py입니다.

EXAMPLES 섹션을 트리거하는 방법에 대해 잘 모르겠습니다. 아직 표준 파이썬 라이브러리의 pydoc 출력에서 EXAMPLE 절의 예제를 찾을 수 없습니다 (그러나 모든 항목을 탐색하지는 못했습니다). 어쩌면 패키지의 문서화 문자열에 긴 설명에 그러한 섹션을 추가 할 수 있습니다. 그러나 표준 라이브러리에서 그렇게하지 않는 것처럼 보이기 때문에 예제를 넣는 것이 적절하지 않을 수 있습니다.

출처

2016-09-08 15:25:19 zezollo

파이썬 pydoc이

답변

관련 문제