وOkydoky هو باني الوثائق الآلي باستخدام أبو الهول، وتوزيع جيثب (الذي كان setuptools) على & nbsp؛ فهو يجعل مشروع بيثون مغلقة لبناء باستمرار الوثائق، مع الافتراضات التالية:
يتم 1. التوثيق باستخدام أبو الهول.
يتم تعبئتها 2. مشروع من خلال setuptools (لا اللدود ولا أي أشخاص آخرين).
ويدير 3. شفرة المصدر تحت جيثب.
أن نقول فترة وجيزة، انها مجرد ReadTheDocs.org للاستخدام الخاص.
كيف تعمل
وهو يعمل في الإرشادات التالية:
1. عندما يتم دفع يرتكب جديدة، جيثب يطلق Okydoky بعد تلقي هوك.
2. التنزيلات Okydoky كتل القطران محفوظات يرتكب دفعت من جيثب.
يحصل استخراج 3. كتل القطران الأرشيف في دليل مؤقت.
4. أبو الهول يبني الوثائق.
5. عندما يطلب مستخدمين مستندات باستخدام متصفح الويب الخاصة بهم، Okydoky يطلب من المستخدم لمصادقة باستخدام جيثب أوث.
6. إذا كانت لديه إذن، يخدم Okydoky بنيت مستندات.
طريقة الاستخدام
انها حزمة بيثون العادية. يمكنك تثبيته باستخدام easy_install:
على & nbsp؛ easy_install Okydoky
توفر هذه الحزمة برنامج نصي سطر الأوامر تسمى okydoky. انها تطبيق على شبكة الإنترنت وأيضا خادم الويب صغير لنفسها. فإنه يأخذ ملف التكوين.
ملفات التكوين يجب أن تحتوي على بعض القيم المطلوبة مثل جيثب مفتاح التطبيق والمفتاح السري.
لديك لإنشاء تطبيق جيثب لاستخدام Okydoky. في استدعاء URL مهم جدا. ملء مع:
HTTP: // <المضيف> / المصادقة / وضع الصيغة النهائية
ويحل محل <المضيف> مع اسم المجال ما عليك استخدامها. وبعد ذلك، إضافة بعد تلقي هوك في مستودع جيثب الخاص بك:
HTTP: // <المضيف> /
إذا قمت بإجراء ملف التكوين، ثم قم بتشغيل خادم Okydoky باستخدام النصي okydoky:
على & nbsp؛ -H okydoky 0.0.0.0 -p 8080 yourconfig.py
وأخيرا، لديك لجعل المصادقة الأولية لإنهاء التثبيت. فتح HTTP: // <المضيف> / في متصفح الويب الخاص بك، والدخول مع جيثب من هناك.
ترتيب
ملف التكوين هو السيناريو بيثون العادي. ويستخدم نظام التكوين قارورة ل. قراءة مستندات قارورة حول ملفات التكوين.
مستودع
على & nbsp؛ اسم المستخدم ومستودع مثلا "crosspop / okydoky".
CLIENT_ID
على & nbsp؛ مفتاح العميل تطبيق جيثب ل.
CLIENT_SECRET
على & nbsp؛ المفتاح السري تطبيق جيثب ل.
SAVE_DIRECTORY
ونبسب؛ مسار الدليل لتخزين البيانات. وهذا دليل تخزين بعض البيانات تكوين، كتل القطران، والوثائق بناؤها.
SECRET_KEY
على & nbsp؛ المفتاح السري للتوقيع الجلسات. انظر مستندات قارورة حول الدورات أيضا.
المصدر المفتوح
هو مكتوب Okydoky التي كتبها Minhee كونغ لCrosspop. لقد وزعت بموجب ترخيص معهد ماساتشوستس للتكنولوجيا، وشفرة المصدر ويمكن العثور عليها في مستودع جيثب. الدفع:
على & nbsp؛ بوابة استنساخ بوابة: //github.com/crosspop/okydoky.git
ما هو الجديد في هذا الإصدار:
جيثب اضطر الدولة لأوث. اتبع ذلك.
ما هو الجديد في الإصدار 0.9.4:
استخدم الخيار --upgrade لsetup.py تطوير الأوامر. وهذا ما يمنع الصراعات نسخة من التبعيات.
يتم ترك بناء السجلات في ملف build.txt.
ما هو الجديد في الإصدار 0.9.3:
والآن أظهرت صفحة الفهرس قائمة الحكام.
الآن مجموعات Okydoky OKYDOKY = 1 متغير البيئة أثناء عملية الإنشاء فيها. [# 5]
إضافة / رئيس خاصا رابط المرجع.
إصلاح الخلل الذي لم يتم تعيين رئيس لأحدث يرتكبها.
ما هو الجديد في الإصدار 0.9.2:
إصلاح الخلل الأمني: الآن يجب أن يكون لدى المستخدمين على ترخيص لمستودع. [# 4]
المتطلبات:
بيثون
لم يتم العثور على التعليقات