Συζήτηση
Γεια χαρά, Επισκέπτης
Όνομα χρήστη: Κωδικός: Να με θυμάσαι

ΘΕΜΑ: [doc] Sphinx

[doc] Sphinx 6 Χρόνια 9 Μήνες πριν #1313

  • pmav99
  • Το Άβαταρ του/της pmav99
  • Αποσυνδεμένος
  • Author
  • Δημοσιεύσεις: 674
  • Ληφθείσες Ευχαριστίες 108
Την αξία του καλού 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
Τελευταία διόρθωση: 6 Χρόνια 9 Μήνες πριν από pmav99.
Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Απ: [doc] Sphinx 6 Χρόνια 9 Μήνες πριν #1345

  • myle
  • Το Άβαταρ του/της myle
  • Αποσυνδεμένος
  • Admin
  • Δημοσιεύσεις: 467
  • Ληφθείσες Ευχαριστίες 14
Με λίγα λόγια, αν ακολουθούμε τις προτεινόμενες συμβάσεις στο PEP 257, το documentation παράγεται ωραία και σχεδόν αυτόματα. Με ένα σμπάρο, δυο τριγώνια (και documentation μέσα στον κώδικα, και εύκολη παρουσίαση του πχ online).
«Αν υποθέσουμε ότι αυτό είναι δυνατό, (να μεταδώσουμε τη σοφία παντού) τότε ειλικρινά ο τρόπος ζωής των θεών θα περάσει στους ανθρώπους. Τα πάντα θα είναι γεμάτα...
Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.

Απ: [doc] Sphinx 6 Χρόνια 8 Μήνες πριν #1367

  • pmav99
  • Το Άβαταρ του/της pmav99
  • Αποσυνδεμένος
  • Author
  • Δημοσιεύσεις: 674
  • Ληφθείσες Ευχαριστίες 108
Πρέπει να είστε εγγεγραμμένο μέλος του Φόρουμ για να κάνετε μια δημοσίευση.
Συντονιστές: pmav99
Χρόνος δημιουργίας σελίδας: 0.328 δευτερόλεπτα

Μοιράσου το!

Powered by CoalaWeb

Λίστα Ταχυδρομείου