Pydoc으로 문서를 작성하려면 어떻게 해야 합니까?

Pydoc으로 문서를 작성하려면 어떻게 해야 합니까?

모듈에서 문서를 작성하려고 합니다.사용한pydocPython 3.2.3을 사용하는 윈도우즈 7의 명령줄에서 다음을 수행합니다.

python "<path_to_pydoc_>\pydoc.py" -w myModule

이로 인해 셸은 모듈의 각 파일에 대해 한 줄씩 텍스트로 채워졌습니다.

no Python documentation found for '<file_name>'

마치 Pydoc이 제 파일에 대한 문서를 가져오려고 하지만, 저는 자동으로 문서를 만들고 싶습니다.구글을 이용한 좋은 튜토리얼을 찾을 수 없었습니다.Pydoc 사용법에 대한 팁이 있는 사람?

다음을 사용하여 하나의 파일에서 문서를 작성하려는 경우

python ... -w myModule\myFile.py

라고 씌어 있습니다wrote myFile.html그리고 제가 그것을 열었을 때, 다음과 같은 한 줄의 텍스트가 있습니다.

# ../myModule/myFile.py

또한 클릭할 수 있는 컴퓨터의 파일 자체에 대한 링크가 있으며 웹 브라우저에서 파일 내부의 내용을 표시합니다.

사람들이 유용하다고 생각하는 또 다른 것은...모듈 이름에서 ".py"를 제외해야 합니다.예를 들어, 'original'의 'original'에 대한 문서를 생성하려는 경우입니다.파이':

yourcode_dir$ pydoc -w original.py
no Python documentation found for 'original.py'

yourcode_dir$ pydoc -w original
wrote original.html

pydoc은 문서를 생성하는 데 환상적이지만, 문서는 우선 작성되어야 합니다.RocketDonkey가 코멘트에서 언급한 바와 같이 소스 코드에 docstring이 있어야 합니다.

"""
This example module shows various types of documentation available for use
with pydoc.  To generate HTML documentation for this module issue the
command:

    pydoc -w foo

"""

class Foo(object):
    """
    Foo encapsulates a name and an age.
    """
    def __init__(self, name, age):
        """
        Construct a new 'Foo' object.

        :param name: The name of foo
        :param age: The ageof foo
        :return: returns nothing
        """
        self.name = name
        self.age = age

def bar(baz):
    """
    Prints baz to the display.
    """
    print baz

if __name__ == '__main__':
    f = Foo('John Doe', 42)
    bar("hello world")

첫 번째 docstring은 pydoc으로 문서를 작성하는 방법을 제공합니다.다양한 유형의 문서 문자열의 예가 있으므로 pydoc으로 생성할 때 문서 문자열의 모양을 확인할 수 있습니다.

RocketDonkey가 제안했듯이 모듈 자체에 몇 가지 의사 문자열이 필요합니다.

예를 들어,myModule/__init__.py:

"""
The mod module
"""

의 각 파일에 대한 문서를 생성할 수도 있습니다.myModule/*.py사용.

pydoc myModule.thefilename

생성된 파일이 기본 모듈 문서 파일에서 참조되는 파일과 일치하는지 확인합니다.

Windows 7에서 작동:

python -m pydoc -w my_module

언급URL : https://stackoverflow.com/questions/13040646/how-do-i-create-documentation-with-pydoc