Wie schreibe ich die Dokumentation nach dem Schreiben des Python-Moduls?

Question

Ich bin ein Neuling und habe noch nie ein Python-Programm veröffentlicht.
Kürzlich hat mich der Lehrer gebeten, zwei kleine Python-Module zu schreiben, eines zum Konvertieren von PDF in TXT und das andere zum Berechnen der Ähnlichkeit des konvertierten TXT-Dokuments. Ich habe es geschrieben und weiß, wie ich es in eine Bibliothek eines Drittanbieters packen soll, aber ich weiß nicht, wie ich die unterstützende Dokumentation schreiben soll?
Ich habe auch im Internet nachgesehen, dass der Inhalt des Kommentars das Dokument ist (ich habe diesen Kommentar sorgfältig geschrieben), aber ich weiß nicht, ob ich eine TXT-Datei in das Paket einfügen und schreiben muss unterschiedliche Funktionen in unterschiedlichen Modulen nutzen, oder was?
Vielen Dank an alle, ich weiß wirklich nicht, wie ich dieses Dokument erstellen soll...

Answer 1

sphinx

Answer 2

我猜你也用过git，类似于git project中的readme 文件，看两个开源项目是怎么写的，写readme的目的，大概就是帮助别人知道这个项目是什么，能干什么，如何使用，注意要点，差不多就酱

Answer 3

例子：

模块.py

'''
这是模块文档
'''
pass

>>> import 模块
>>> help(模块)
Help on module 模块:

NAME
    模块 - 这是模块文档

FILE
    d:\python34\模块.py


>>>