pydoc으로 Python 문서 자동 생성

Python은 pydoc과 함께 제공됩니다. pydoc 을 사용 하여 모듈 또는 패키지에 대한 문서를 자동 생성할 수 있습니다. 이를 위해 모듈 또는 패키지에 독스트링이 포함되어야 합니다.

터미널에서 직접 pydoc 을 실행할 수 있습니다 . 문서를 자동 생성하려는 모듈이 포함된 디렉토리로 cd하십시오. 그런 다음 다음 명령을 실행합니다.

python -m pydoc -w modulename

이 경우 모듈은 modulename.py입니다. 위의 명령은 자동 생성 문서가 포함된 .html 파일을 생성합니다.

더 큰 프로젝트의 경우 모든 모듈에 대한 모든 문서를 하나의 디렉토리에 저장하는 것을 선호합니다. 이를 위해 먼저 모든 모듈에 대한 문서를 작성합니다. 나는 위의 명령으로 그렇게합니다.

다음으로 아래 명령을 사용하여 빈 디렉터리를 만듭니다.

mkdir docs

이 경우 새 디렉토리를 “docs”라고 합니다.

마지막으로 자동 생성된 모든 .html 파일을 docs 디렉토리로 이동합니다.

mv *.html docs
Close

메타