Selepas menulis modul python, bagaimana untuk menulis dokumentasi?

Question

Saya masih baru dan tidak pernah menerbitkan program ular sawa sebelum ini.
Baru-baru ini, cikgu meminta saya menulis dua modul ular sawa kecil, satu untuk menukar pdf kepada txt, dan satu lagi untuk mengira persamaan dokumen txt yang ditukar. Saya telah menulisnya dan tahu cara membungkusnya ke dalam perpustakaan pihak ketiga, tetapi saya tidak tahu cara menulis dokumentasi sokongan?
Saya juga menyemak di Internet Sesetengah orang mengatakan bahawa kandungan dalam ulasan adalah dokumen (saya menulis ulasan ini dengan teliti), tetapi saya tidak tahu sama ada saya perlu meletakkan fail txt dalam pakej dan menulisnya untuk menggunakan fungsi yang berbeza dalam modul yang berbeza, atau apa?
Terima kasih semua, saya betul-betul tak tahu nak buat dokumen ni...

Answer 1

sphinx

Answer 2

Saya rasa anda juga telah menggunakan git, yang serupa dengan fail readme dalam projek git Lihat bagaimana dua projek sumber terbuka ditulis Tujuan menulis readme mungkin untuk membantu orang lain mengetahui apakah projek itu boleh lakukan, dan cara menggunakannya Sila ambil perhatian Perkara utama, hampir cukup sos

Answer 3

Contoh:

模块.py

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

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

NAME
    模块 - 这是模块文档

FILE
    d:\python34\模块.py


>>>