.
Okydoky سازنده مستندات خودکار با استفاده از مجسمه ابوالهول، پخش و گیتهاب (که setuptools بود) و nbsp است. این باعث می شود پروژه پایتون بسته خود را به طور مداوم ساخت مستندات، با مفروضات زیر است:
1. اسناد با استفاده از مجسمه ابوالهول انجام می شود.
2. پروژه از طریق setuptools بسته بندی (PIP و نه از دیگران).
3. کد منبع تحت گیتهاب اداره می شود.
می گویند به زودی، آن را به سادگی ReadTheDocs.org برای استفاده خصوصی.
چگونه کار می کند
این در دستورالعمل زیر کار می کند:
1. هنگامی که تصدیق جدید تحت فشار قرار دادند، گیتهاب باعث Okydoky پس از دریافت قلاب.
2. دانلود Okydoky بسته آرشیو تصدیق تحت فشار قرار دادند از گیتهاب.
3. بایگانی بسته می شود به یک دایرکتوری موقت استخراج شده است.
4. مجسمه ابوالهول ایجاد مستندات.
5. هنگامی که کاربران درخواست اسناد با استفاده از مرورگر وب خود، Okydoky می پرسد کاربر برای تأیید اعتبار با استفاده از گیتهاب OAuth تأیید.
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 گسترش: // <میزبان> / در مرورگر خود و وارد سایت شوید با گیتهاب از وجود دارد.
پیکر بندی
فایل پیکربندی یک اسکریپت پایتون طبیعی است. آن استفاده می کند سیستم پیکربندی فلاسک است. خوانده شده اسناد فلاسک در مورد فایل های پیکربندی.
مخزن
را لمس کنید و. نام کاربری و مخزن به عنوان مثال 'crosspop / okydoky.
CLIENT_ID
و nbsp؛ کلید مشتری نرم افزار گیتهاب است.
CLIENT_SECRET
و nbsp؛ کلید مخفی برنامه گیتهاب است.
SAVE_DIRECTORY
& nbsp؛ در مسیر دایرکتوری برای ذخیره داده ها. این دایرکتوری برخی از پیکربندی داده ها، بسته، و مستندات ساخته شده را ذخیره کنید.
SECRET_KEY
& nbsp؛ در کلید مخفی را امضا جلسات. اسناد فلاسک را در مورد جلسات نیز مشاهده کنید.
منبع باز
Okydoky توسط هنگ Minhee برای Crosspop نوشته شده است. این تحت لیسانس MIT توزیع شده، و کد منبع را می توان در مخزن گیتهاب یافت. اتمام:
& nbsp؛ در دستگاه گوارش کلون دستگاه گوارش: //github.com/crosspop/okydoky.git
چه جدید در این نسخه است:
در گیتهاب دولت برای OAuth تأیید مجبور. دنبال که.
جدید در نسخه 0.9.4 است:
استفاده از گزینه --upgrade برای setup.py توسعه فرمان. این مانع از درگیری نسخه از وابستگی.
ساخت سیاهههای مربوط در فایل build.txt باقی مانده است.
جدید در نسخه 0.9.3 است:
در حال حاضر صفحه اول را نشان می دهد لیستی از refs.
در حال حاضر مجموعه Okydoky در طول فرآیند ساخت آن OKYDOKY = 1 متغیر محیط زیست است. [# 5]
اضافه کردن / سر URL کد عکس ویژه.
رفع اشکال که سر به آخرین مرتکب تنظیم نشده.
جدید در نسخه 0.9.2 است:
رفع اشکال امنیتی: در حال حاضر کاربران باید مجوز مخزن داشته باشد. [# 4]
مورد نیاز:
پایتون
نظر یافت نشد