sphinx-me

σφίγγα-me είναι ένα εργαλείο Python που θα δημιουργήσει μια Σφίγγα κέλυφος τεκμηρίωση για το έργο σας και να συμπεριλάβετε το αρχείο README ως δείκτης τεκμηρίωσης & nbsp?. Χειρίζεται την εξαγωγή των απαιτούμενων μετα-δεδομένα όπως το όνομα του έργου, συγγραφέας και έκδοση από σας Project για χρήση στο Σφίγγα τα έγγραφά σας.
Μόλις χρησιμοποιήσετε σφίγγα-να φτιάξω Σφίγγα τα έγγραφά σας, μπορείτε να προσθέσετε στη συνέχεια το έργο σας στο δικτυακό τόπο διαβάσει το εγχειρίδιο και έχουν README του έργου σας φιλοξενείται με ένα ελκυστικό θέμα τεκμηρίωσης Σφίγγα.
Σημείωση: αρχείο README σας θα πρέπει να είναι σε μορφή συμβατή reStructuredText.
installation
Ο ευκολότερος τρόπος για να εγκαταστήσετε σφίγγα-μένα είναι απευθείας από PyPI χρησιμοποιώντας pip ή setuptools εκτελώντας την αντίστοιχη εντολή παρακάτω:
PIP εγκαταστήσετε -U σφίγγα-μένα
ή:
easy_install -U σφίγγα-μένα
Διαφορετικά μπορείτε να κατεβάσετε σφίγγα-μου και να το εγκαταστήσετε απευθείας από την πηγή:
python setup.py εγκαταστήσετε
Τρέξιμο
Σφίγγα-μένα θα εγκατασταθεί ως ένα σύστημα σε επίπεδο σεναρίου που μπορούν να εκτελεστούν από τη γραμμή εντολών, ενώ στον κατάλογο ρίζας του έργου σας:
σφίγγα-μένα
Όταν τρέχει στον κατάλογο του έργου σας, θα δημιουργήσει έναν κατάλογο docs με δύο αρχεία, τη μονάδα conf.py Σφίγγα, και ένα index.rst αρχείο το οποίο θα περιλαμβάνει README του έργου σας.
Η conf.py ενότητα καλεί μια λειτουργία ρύθμισης από σφίγγα-μένα που καταρτίζει το ελάχιστο απαιτούμενο ρυθμίσεις για Σφίγγα τα έγγραφά σας.
- Έργο - το όνομα του καταλόγου του έργου σας χρησιμοποιείται.
- Έκδοση - που ανακτώνται από την έκδοση arg της setup.py script σας, ή __version__ χαρακτηριστικό του πακέτου σας.
- Τα δικαιώματα πνευματικής ιδιοκτησίας - που ανακτώνται από το συγγραφέα arg του σεναρίου setup.py σας, ή __author__ χαρακτηριστικό του πακέτου σας

Απαιτήσεις :

• . Python