Okydoky היא בונה תיעוד אוטומטית באמצעות הספינקס, הפץ וGitHub (שהיה setuptools) & nbsp; זה עושה פרויקט Python הסגור שלך כדי לבנות ברציפות תיעוד, עם ההנחות הבאות.:
1. תיעוד נעשה באמצעות הספינקס.
2. פרויקט ארוז דרך setuptools (לא פיפס ולא כל האחרים).
קוד מקור 3. מנוהל תחת GitHub.
לומר זמן קצר, זה פשוט ReadTheDocs.org לשימוש פרטי.
איך זה עובד
זה עובד בהוראות הבאות:
1. כשיתחייב חדש נדחפים, GitHub מפעיל פוסט-קבלת Okydoky וו.
2. הורדות Okydoky tarball ארכיונים של יתחייב דחף מGitHub.
3. ארכיון tarball מקבל חילוץ לספרייה זמנית.
4. הספינקס בונה את התיעוד.
5. כאשר משתמשים לבקש מסמכים באמצעות דפדפן האינטרנט שלהם, Okydoky שואל את המשתמש לאימות באמצעות GitHub OAuth.
6. אם יש להם את האישור, Okydoky משמש מסמכים מובנים.
כיצד להשתמש ב
זה חבילת Python רגילה. אתה יכול להתקין אותו באמצעות easy_install:
& Nbsp; easy_install Okydoky
חבילה זו מספקת תסריט שורת הפקודה נקרא okydoky. זה יישום אינטרנט וגם שרת אינטרנט קטן לעצמו. זה לוקח קובץ config.
קבצי config צריכים להכיל כמה ערכים נדרשים כמו מפתח יישום GitHub ומפתח סודי.
אתה צריך ליצור יישום GitHub להשתמש Okydoky. Callback כתובת האתר שלו הוא מאוד חשוב. למלא אותו עם:
http: // / auth / לסיים <מארח>
ומחליף את <מארח> עם שם תחום מה שאתה תשתמש. ולאחר מכן, להוסיף וו לקבל-פוסט למאגר GitHub שלך:
http: // <מארח> /
אם אתם עושים קובץ config, ולאחר מכן להפעיל שרת Okydoky באמצעות תסריט okydoky:
& Nbsp; -H okydoky 0.0.0.0 yourconfig.py 8080 -p
לבסוף, אתה חייב לעשות את auth ראשוני כדי לסיים את ההתקנה. http הפתוח: // <מארח> / בדפדפן האינטרנט שלך ולהתחבר עם GitHub משם.
תצורה
קובץ config הוא סקריפט פייתון נורמלי. היא משתמשת במערכת config של הבקבוק. קראו המסמכים של Flask על קבצי config.
מאגר
& Nbsp; שם המשתמש ומאגר לדוגמה: "Crosspop / okydoky '.
CLIENT_ID
& Nbsp; מפתח לקוח של יישום GitHub.
CLIENT_SECRET
& Nbsp; מפתח הסודי של יישום GitHub.
SAVE_DIRECTORY
& Nbsp; הנתיב של הספרייה לאחסון נתונים. במדריך זה יהיה לאחסן נתונים מסוימים, ארכיבים, ותיעוד מובנה מוגדרים.
SECRET_KEY
& Nbsp; מפתח הסודי לחתום מפגשים. ראה מסמכים של Flask על מפגשים גם.
מקור Open
Okydoky נכתב על ידי הונג Minhee לCrosspop. זה מופץ תחת רישיון MIT, וניתן למצוא את קוד המקור במאגר GitHub. עזיבה:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git
מה חדש בהודעה זו :
- > GitHub נאלץ מדינה לOAuth. בצע את זה.
מה חדש בגרסה 0.9.4:
- השתמש באפשרות --upgrade לsetup.py לפתח הפקודה. זה מונע סכסוכי גרסה של תלות.
- יומני בנייה נותרו בקובץ build.txt.
מה חדש בגרסת 0.9.3:
- עכשיו דף האינדקס מציג את רשימת השופטים.
מה חדש בגרסה 0.9.2:
- תוקן באג אבטחה: עכשיו יש לי משתמשים אישור למאגר. [# 4]
דרישות :
- Python
תגובות לא נמצא