Après avoir écrit le module python, comment rédiger la documentation ?

Question

Je suis un débutant et je n'ai jamais publié de programme Python auparavant.
Récemment, le professeur m'a demandé d'écrire deux petits modules python, l'un pour convertir le pdf en txt et l'autre pour calculer la similarité du document txt converti. Je l'ai écrit et je sais comment l'emballer dans une bibliothèque tierce, mais je ne sais pas comment rédiger la documentation de support ?
J'ai également vérifié sur Internet. Certaines personnes ont dit que le contenu du commentaire est le document (j'ai écrit ce commentaire avec soin), mais je ne sais pas si je dois mettre un fichier txt dans le package et l'écrire. utiliser différentes fonctions dans différents modules, ou quoi ?
Merci à tous, je ne sais vraiment pas comment faire ce document...

Answer 1

sphinx

Answer 2

Je suppose que vous avez également utilisé git, qui est similaire au fichier readme du projet git. Regardez comment les deux projets open source sont écrits. Le but de l'écriture du readme est probablement d'aider les autres à savoir ce qu'est le projet, de quoi il s'agit. peut faire, et comment l'utiliser. Veuillez faire attention aux points principaux, presque assez de sauce

.

Answer 3

Exemple :

模块.py

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

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

NAME
    模块 - 这是模块文档

FILE
    d:\python34\模块.py


>>>