Okydoky

Okydoky είναι ένα αυτοματοποιημένο οικοδόμος τεκμηρίωσης χρησιμοποιώντας Σφίγγα, διανομή και GitHub (που ήταν setuptools) & nbsp? Κάνει κλειστά έργου Python σας για να οικοδομήσουμε συνεχώς τεκμηριώσεις, με τις ακόλουθες παραδοχές.:
1. Τεκμηρίωση γίνεται με τη χρήση Σφίγγα.
2. Έργο είναι συσκευασμένο μέσα setuptools (δεν pip ούτε οποιεσδήποτε άλλες).
3. Ο πηγαίος κώδικας διοικείται υπό GitHub.
Για να πω σύντομα, είναι απλά ένα ReadTheDocs.org για ιδιωτική χρήση.
Πώς λειτουργεί
Λειτουργεί με τις παρακάτω οδηγίες:
1. Όταν τα νέα commits έσπρωξε, GitHub πυροδοτεί Okydoky μετα-λαμβάνουν γάντζο.
2. Okydoky λήψεις tarball αρχεία έσπρωξε commits από GitHub.
3. Tarball αρχείο παίρνει εξάγεται σε έναν προσωρινό κατάλογο.
4. Σφίγγα χτίζει την τεκμηρίωση.
5. Όταν οι χρήστες ζητούν τα docs χρησιμοποιούν τους web browser, Okydoky ζητά από το χρήστη για τον έλεγχο ταυτότητας χρησιμοποιώντας GitHub OAuth.
6. Αν έχει την άδεια, Okydoky εξυπηρετεί ένα ενσωματωμένο docs.
Πώς να χρησιμοποιήσετε το
Είναι ένα συνηθισμένο πακέτο Python. Μπορείτε να το εγκαταστήσετε χρησιμοποιώντας easy_install:
& Nbsp? Easy_install Okydoky
Αυτό το πακέτο παρέχει μια δέσμη ενεργειών γραμμής εντολών που ονομάζεται okydoky. Είναι μια web εφαρμογή και επίσης ένα μικρό web server για τον εαυτό της. Χρειάζεται ένα αρχείο ρυθμίσεων.
Αρχεία ρυθμίσεων πρέπει να περιέχει κάποιες απαιτούμενες αξίες όπως η εφαρμογή GitHub κλειδί και το μυστικό κλειδί.
Θα πρέπει να δημιουργήσετε μια εφαρμογή GitHub να χρησιμοποιήσετε Okydoky. Τηλεφωνική URL του είναι πολύ σημαντική. Γεμίστε το με:
http: // / auth / οριστικοποίησης
και αντικαθιστά με το όνομα τομέα που θα χρησιμοποιήσουμε. Και στη συνέχεια, προσθέστε μια μετα-λαμβάνουν γάντζο στο GitHub αποθετήριο σας:
http: // /
Αν κάνετε ένα αρχείο ρυθμίσεων, στη συνέχεια, εκτελέστε μια Okydoky διακομιστή χρησιμοποιώντας okydoky σενάριο:
& Nbsp? Okydoky -Η 0.0.0.0 -p 8080 yourconfig.py
Τέλος, θα πρέπει να κάνουν μια αρχική ΑΠΘ για να ολοκληρωθεί η εγκατάσταση. Ανοιχτό http: // / στο web browser σας και να συνδεθείτε με το GitHub από εκεί.
Διαμόρφωση
Το αρχείο ρυθμίσεων είναι ένα κανονικό σενάριο Python. Χρησιμοποιεί το σύστημα διαμόρφωσης θερμού. Διαβάστε docs Φιάλη σχετικά αρχεία ρυθμίσεων.
ΑΠΟΘΗΚΕΥΣΗΣ
& Nbsp? Το όνομα χρήστη και αποθήκη π.χ. «Crosspop / okydoky».
CLIENT_ID
& Nbsp? Κλειδί του πελάτη της εφαρμογής GitHub.
CLIENT_SECRET
& Nbsp? Μυστικό κλειδί της εφαρμογής GitHub.
SAVE_DIRECTORY
& Nbsp? Η διαδρομή του καταλόγου για την αποθήκευση δεδομένων. Αυτός ο κατάλογος θα αποθηκεύσετε κάποια δεδομένα που έχετε ρυθμίσει, tarballs, και χτίστηκε τεκμηριώσεις.
SECRET_KEY
& Nbsp? Το μυστικό κλειδί για την υπογραφή συνεδρίες. Δείτε docs Φιάλη σχετικά συνεδρίες επίσης.
Open source
Okydoky είναι γραμμένο από το Χονγκ Minhee για Crosspop. Διανέμεται με άδεια MIT, και ο πηγαίος κώδικας μπορεί να βρεθεί στο αποθετήριο GitHub. Αναχώρηση:
& Nbsp? Git κλώνος git: //github.com/crosspop/okydoky.git

Τι είναι καινούργιο σε αυτήν την έκδοση:

• GitHub αναγκαστική κατάσταση για OAuth. Ακολουθήστε αυτό.

Τι είναι καινούργιο στην έκδοση 0.9.4:

• Χρησιμοποιήστε --upgrade επιλογή για setup.py αναπτύξουν εντολή. Αυτό εμποδίζει την έκδοση των συγκρούσεων εξαρτήσεις.

Οι
• Build κούτσουρα αριστερά στο αρχείο build.txt.

Τι είναι καινούργιο στην έκδοση 0.9.3:

• Τώρα η σελίδα δείκτης εμφανίζει τη λίστα των διαιτητές.
• Τώρα Okydoky σύνολα OKYDOKY = 1 μεταβλητή περιβάλλοντος κατά τη διάρκεια της διαδικασίας κατασκευής του. [# 5]
• Προσθήκη / ειδική κεφαλή διαιτητής url.
• Διορθώθηκε ένα bug που η κεφαλή δεν έχει οριστεί το αργότερο διαπράξουν.

Τι είναι καινούργιο στην έκδοση 0.9.2:

• Διορθώθηκε ένα σφάλμα ασφαλείας: Τώρα οι χρήστες πρέπει να έχουν μια άδεια για το χώρο αποθήκευσης. [# 4]

Απαιτήσεις :

• Python