Την αξία του καλού documentation την έχουν υμνήσει πολλοί και την έχουν σίγουρα νοιώσει στο πετσί τους όσοι έχουν ασχοληθεί με legacy code (πχ κώδικα σε fortran από το 70...)
Στην python οι οδηγίες του καλού documentation περιγράφονται στο
PEP 257
Το
sphinx είναι ένα πρόγραμμα το οποίο επιτρέπει τη δημιουργία documentation εύκολα και γρήγορα.
Το output μπορεί να είναι τόσο σελίδες html ώστε να μπουν στο site του προγράμματος, όσο και pdfs.
To sphinx επιτρέπει τη δημιουργία documentation τόσο συμβατικά (διαβάζοντας τα docstrings) όσο και σαν tutorial. Στο νετ υπάρχει πληθώρα παραδειγμάτων, με χαρακτηριστικότερο ίσως την ίδια την python documentation. ΕΔΩ μπορείτε να βρείτε ένα (3ωρο...)
video-tutorial από την PyCon 2010
