Okydoky

Okydoky adalah pembangun dokumentasi otomatis menggunakan Sphinx, Mendistribusikan dan GitHub (yang setuptools) & nbsp; Itu membuat proyek Python ditutup Anda untuk terus membangun dokumentasi, dengan asumsi sebagai berikut.:
1. Dokumentasi dilakukan dengan menggunakan Sphinx.
2. Proyek dikemas melalui setuptools (tidak pip maupun orang lain).
3. Source code dikelola di bawah GitHub.
Untuk mengatakan tak lama, itu hanya ReadTheDocs.org untuk penggunaan pribadi.
Cara kerjanya
Ia bekerja dalam petunjuk berikut:
1. Ketika komit baru didorong, GitHub memicu Okydoky pasca-menerima hook.
2. download Okydoky tarball arsip komit mendorong dari GitHub.
3. Tarbal arsip akan diekstraksi ke direktori sementara.
4. Sphinx membangun dokumentasi.
5. Ketika pengguna meminta dokumentasi menggunakan browser web mereka, Okydoky meminta user untuk otentikasi menggunakan GitHub OAuth.
6. Jika mereka memiliki otorisasi, Okydoky menyajikan docs dibangun.
Cara menggunakan
Ini adalah paket Python biasa. Anda dapat menginstalnya menggunakan easy_install:
& Nbsp; easy_install Okydoky
Paket ini menyediakan script baris perintah yang disebut okydoky. Ini adalah aplikasi web dan juga web server kecil untuk dirinya sendiri. Dibutuhkan file konfigurasi.
File konfigurasi harus mengandung beberapa nilai yang diperlukan seperti tombol aplikasi GitHub dan kunci rahasia.
Anda harus membuat aplikasi GitHub untuk menggunakan Okydoky. URL Callback yang sangat penting. Isi dengan:
http: // / auth / finalize
dan menggantikan dengan nama domain apa yang akan Anda gunakan. Kemudian, tambahkan pasca-menerima hook ke repositori GitHub Anda:
http: // /
Jika Anda membuat file konfigurasi, kemudian jalankan server Okydoky menggunakan skrip okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Terakhir, Anda harus membuat otentikasi awal untuk menyelesaikan instalasi. Terbuka http: // / di browser web Anda dan login dengan GitHub dari sana.
Konfigurasi
File konfigurasi adalah skrip Python normal. Menggunakan sistem konfigurasi Flask itu. Baca docs Flask tentang file konfigurasi.
Gudang
& Nbsp; Pengguna dan repositori nama misalnya 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; key Klien GitHub aplikasi.
CLIENT_SECRET
& Nbsp; The GitHub aplikasi kunci rahasia.
SAVE_DIRECTORY
& Nbsp; Jalur direktori untuk menyimpan data. Direktori ini akan menyimpan beberapa data, tarball, dan dokumentasi dibangun dikonfigurasi.
SECRET_KEY
& Nbsp; Kunci rahasia untuk menandatangani sesi. Lihat docs Flask tentang sesi juga.
Open source
Okydoky ditulis oleh Hong Minhee untuk Crosspop. Ini didistribusikan di bawah lisensi MIT, dan kode sumber dapat ditemukan dalam repositori GitHub. Lihat:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Apa yang baru dalam rilis ini:

• GitHub memaksa negara untuk OAuth. Ikuti itu.

Apa yang baru dalam versi 0.9.4:

• Gunakan opsi --upgrade untuk setup.py mengembangkan perintah. Hal ini untuk mencegah konflik versi dependensi.
• Membangun log yang tersisa dalam file build.txt.

Apa yang baru dalam versi 0.9.3:

• Sekarang halaman indeks menampilkan daftar referral.
• Sekarang set Okydoky OKYDOKY = variabel 1 lingkungan selama proses membangun nya. [# 5]
• Add / kepala khusus url ref.
• Fixed bug yang kepala tidak diatur ke terbaru komit.

Apa yang baru dalam versi 0.9.2:

• Fixed bug keamanan: sekarang pengguna harus memiliki otorisasi untuk repositori. [# 4]

Persyaratan :

• Python