Python 모듈을 작성한 후 문서는 어떻게 작성합니까?

Question

저는 초보자이고 이전에 Python 프로그램을 게시한 적이 없습니다.
최근 선생님께서 저에게 두 개의 작은 Python 모듈을 작성하라고 하셨습니다. 하나는 pdf를 txt로 변환하는 것이고, 다른 하나는 변환된 txt 문서의 유사성을 계산하는 것입니다. 나는 그것을 작성했고 이를 타사 라이브러리에 패키징하는 방법을 알고 있지만 지원 문서를 작성하는 방법을 모르겠습니다.
인터넷에서도 확인해보니 댓글 내용이 문서라고 하시는 분들도 계시던데(이 댓글은 꼼꼼히 작성했습니다) 패키지에 txt 파일을 넣어서 작성해야 하는지 모르겠네요. 다른 모듈에서 다른 기능을 사용하는 것, 아니면 무엇을?
모두 감사합니다. 이 문서를 어떻게 작성해야할지 모르겠습니다...

Answer 1

스핑크스

Answer 2

git 프로젝트의 readme 파일과 유사한 git도 사용하셨을 것 같습니다. 두 오픈 소스 프로젝트가 어떻게 작성되었는지 살펴보세요. readme를 작성하는 목적은 아마도 프로젝트가 무엇인지, 무엇인지 알 수 있도록 돕기 위함일 것입니다. 할 수 있고, 사용법도 주의해주세요. 소스는 거의 충분해요

Answer 3

예:

模块.py

으아악 으아악