Σφίγγα είναι ένα εργαλείο που καθιστά εύκολο να δημιουργήσει ένα έξυπνο και όμορφο τεκμηρίωση για τα έργα Python (ή άλλα έγγραφα που αποτελούνται από πολλαπλές πηγές reStructuredText), γραμμένο από τον Georg Μπραντλ. Το έργο είχε αρχικά δημιουργηθεί για να μεταφράσει τη νέα τεκμηρίωση Python, αλλά τώρα έχει καθαριστεί με την ελπίδα ότι θα είναι χρήσιμο για πολλά άλλα έργα.
Σφίγγα χρησιμοποιεί reStructuredText ως γλώσσα σήμανσης της, και πολλά από τα δυνατά σημεία της προέρχεται από τη δύναμη και την αμεσότητα της reStructuredText και ανάλυσης του και τη μετάφραση σουίτα, τα Docutils.
Αν και εξακολουθεί να βρίσκεται υπό συνεχή εξέλιξη, τα ακόλουθα χαρακτηριστικά είναι ήδη παρόντες, δουλεύουν μια χαρά και μπορεί να δει "σε δράση" στα docs Python:
& Nbsp? * Μορφές εξόδου: HTML (συμπεριλαμβανομένων των Windows Βοήθεια HTML) και λατέξ, για εκτυπώσιμες εκδόσεις PDF
& Nbsp? * Εκτεταμένες παραπομπές: σημασιολογική σήμανση και αυτόματες συνδέσεις για τις λειτουργίες, τις κατηγορίες, γλωσσάρι όρων και παρόμοια κομμάτια των πληροφοριών
& Nbsp? * Ιεραρχική δομή: είναι εύκολο να οριστεί από ένα δέντρο εγγράφου, με αυτόματες συνδέσεις με τα αδέλφια, γονείς και παιδιά
& Nbsp? * Αυτόματη δείκτες: Γενικός Δείκτης καθώς και ένα δείκτη ενότητας
& Nbsp? * Χειρισμό Κωδικός: αυτόματη επισήμανση με τη χρήση της επισήμανσης Pygments
& Nbsp? * Διάφορες επεκτάσεις είναι διαθέσιμες, π.χ. . για αυτόματο έλεγχο της δημιουργίας ενός και ένταξης κατάλληλα διαμορφωμένη docstrings
Απαιτήσεις :
- Python
Τα σχόλια δεν βρέθηκε