Okydoky เป็นสร้างเอกสารอัตโนมัติโดยใช้สฟิงซ์กระจายและ GitHub (ซึ่งเป็น setuptools) & nbsp; มันทำให้โครงการหลามของคุณปิดอย่างต่อเนื่องเพื่อสร้างเอกสารด้วยสมมติฐานดังต่อไปนี้.:
1. เอกสารจะกระทำโดยใช้สฟิงซ์
2. โครงการเป็นแพคเกจผ่าน setuptools (ไม่ใช่จุดเล็ก ๆ หรือคนอื่น ๆ )
3. รหัสที่มามีการจัดการภายใต้ GitHub
ที่จะบอกว่าไม่นานก็เพียง ReadTheDocs.org สำหรับการใช้งานส่วนตัว
วิธีการทำงาน
มันทำงานได้ในคำแนะนำต่อไปนี้:
1. เมื่อกระทำใหม่จะผลัก GitHub ทริกเกอร์เบ็ดโพสต์ได้รับ Okydoky
2. ดาวน์โหลด Okydoky tarball จดหมายเหตุของการผลักดันกระทำจาก GitHub
3. เก็บ tarball ได้รับการสกัดลงในไดเรกทอรีชั่วคราว
4. สฟิงซ์สร้างเอกสาร
5. เมื่อผู้ใช้ร้องขอเอกสารโดยใช้เว็บเบราเซอร์ของพวกเขา Okydoky ถามผู้ใช้สามารถตรวจสอบการใช้ GitHub OAuth
6. หากพวกเขามีการอนุมัติ, Okydoky ให้บริการเอกสารที่สร้างขึ้น
วิธีการใช้งาน
มันเป็นแพคเกจงูใหญ่สามัญ คุณสามารถติดตั้งได้โดยใช้ easy_install:
& nbsp; easy_install Okydoky
แพคเกจนี้มีสคริปต์บรรทัดคำสั่งที่เรียกว่า okydoky มันเป็นโปรแกรมเว็บและเว็บเซิร์ฟเวอร์ขนาดเล็กสำหรับตัวเอง มันต้องใช้ไฟล์ config
config ไฟล์ต้องมีค่าที่จำเป็นบางอย่างเช่นแอพลิเคชันที่สำคัญ GitHub และที่สำคัญเป็นความลับ
คุณจะต้องสร้างโปรแกรมประยุกต์ GitHub จะใช้ Okydoky URL โทรกลับมันเป็นสิ่งสำคัญมาก กรอกด้วย:
http: // <โฮสต์> / auth / จบ
และแทนที่ <โฮสต์> ด้วยชื่อโดเมนสิ่งที่คุณจะใช้ แล้วเพิ่มเบ็ดได้รับการโพสต์ลงพื้นที่เก็บข้อมูล GitHub ของคุณ:
http: // <โฮสต์> /
ถ้าคุณทำไฟล์ config แล้วเรียกใช้เซิร์ฟเวอร์ Okydoky ใช้สคริปต์ okydoky:
& nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
สุดท้ายคุณจะต้องทำให้การรับรองความถูกต้องเริ่มต้นที่จะเสร็จสิ้นการติดตั้ง เปิด http: // <โฮสต์> / ในเว็บเบราเซอร์ของคุณและเข้าสู่ระบบด้วย GitHub จากที่นั่น
การตั้งค่า
ไฟล์ config เป็นสคริปต์หลามปกติ โดยจะใช้ระบบการตั้งค่าของขวด อ่านเอกสารขวดเกี่ยวกับ config ไฟล์
พื้นที่เก็บข้อมูล
& nbsp; ชื่อผู้ใช้และพื้นที่เก็บข้อมูลเช่นที่ 'crosspop / okydoky'
CLIENT_ID
& nbsp; ที่สำคัญลูกค้าของแอปพลิเค GitHub
CLIENT_SECRET
& nbsp; คีย์ลับแอพลิเคชันของ GitHub
SAVE_DIRECTORY
& nbsp; เส้นทางของไดเรกทอรีการจัดเก็บข้อมูล ไดเรกทอรีนี้จะเก็บข้อมูลการกำหนดค่าบาง tarballs และเอกสารที่สร้างขึ้น
secret_key
& nbsp; ความลับสำคัญที่จะลงนามการประชุม ดูเอกสารของขวดเกี่ยวกับการประชุมนอกจากนี้ยังมี
เปิดแหล่งที่มา
Okydoky ที่เขียนโดย Hong Minhee สำหรับ Crosspop มันกระจายภายใต้ใบอนุญาต MIT และรหัสแหล่งที่สามารถพบได้ในพื้นที่เก็บข้อมูล GitHub เช็คเอาท์:
& nbsp; คอมไพล์คอมไพล์โคลน: //github.com/crosspop/okydoky.git
มีอะไรใหม่ ในข่าวประชาสัมพันธ์นี้:
- GitHub บังคับรัฐสำหรับ OAuth ตามที่.
มีอะไรใหม่ ในรุ่น 0.9.4:
- ใช้ตัวเลือก --upgrade สำหรับ setup.py พัฒนา คำสั่ง นี้จะช่วยป้องกันความขัดแย้งรุ่นการอ้างอิง.
- สร้างบันทึกที่เหลือในแฟ้ม build.txt.
มีอะไรใหม่ ในรุ่น 0.9.3:
- ตอนนี้หน้าดัชนีแสดงรายการของ refs
- ตอนนี้ชุด Okydoky OKYDOKY = 1 ตัวแปรสภาพแวดล้อมในระหว่างขั้นตอนการสร้างของ [# 5]
- เพิ่ม / หัว url อ้างอิงพิเศษ.
- แก้ไข bug ที่หัวไม่ได้ตั้งค่าล่าสุดกระทำ.
มีอะไรใหม่ ในรุ่น 0.9.2:
- แก้ไข bug การรักษาความปลอดภัย: ตอนนี้ผู้ใช้จะต้องมี การอนุญาตสำหรับพื้นที่เก็บข้อมูล [# 4]
ต้องการ
- หลาม
ความคิดเห็นที่ไม่พบ