.
Okydoky Sfenks, dağıtın ve GitHub (setuptools olan) & nbsp kullanarak otomatik belge kurucusudur; Sürekli aşağıdaki varsayımlarla, dokümantasyon oluşturmak için kapalı Python proje yapar:
1. Belgeler Sfenks kullanılarak yapılır.
2. Projesi (pip ne de herhangi diğerleri) setuptools ile paketlenir.
3. Kaynak kodu GitHub altında yönetilir.
Kısa bir süre söylemek için, sadece özel kullanım için bir ReadTheDocs.org var.
Nasıl çalışır?
Aşağıdaki talimatlar çalışır:
Yeni kaydedilmesini itti zaman 1. GitHub kanca-sonrası aldığınız Okydoky tetikler.
2. Okydoky indirme GitHub itti kaydedilmesini arşivleri Arşivini.
3. Tarball arşivi geçici bir dizine ayıklanır.
4. Sfenks belgeleri oluşturur.
Kullanıcıların kendi web tarayıcısı kullanarak docs talep ettiğinde 5., Okydoky GitHub OAuth kullanarak kimlik doğrulaması için kullanıcıya sorar.
Onlar yetki varsa 6., Okydoky yerleşik belgeler hizmet vermektedir.
nasıl kullanılır
Bu sıradan bir Python paketi var. Sen easy_install kullanarak yükleyebilirsiniz:
& Nbsp; easy_install Okydoky
Bu paket, okydoky adında bir komut satırı komut dosyası sağlar. Bir web uygulaması ve aynı zamanda kendisi için küçük bir web sunucusu bulunuyor. Bir yapılandırma dosyası alır.
Yapılandırma dosyaları GitHub uygulama tuşu ve gizli anahtar gibi bazı gerekli değerleri içermek zorunda.
Sen Okydoky kullanmak için bir GitHub uygulaması oluşturmak zorunda. Onun Geri URL çok önemlidir. Bunu doldurun:
http: //
ve yerini
http: //
Bir yapılandırma dosyası yaparsanız, o zaman okydoky komut dosyası kullanarak bir Okydoky sunucusu çalıştırmak:
& Nbsp; okydoky H 0.0.0.0 -p 8080 yourconfig.py
Son olarak, yüklemeyi bitirmek için bir başlangıç auth yapmak zorunda. Açık http: //
Yapılandırma
yapılandırma dosyası normal bir Python komut olduğunu. Bu Flask config sistemini kullanır. Yapılandırma dosyaları hakkında Flask en dokümanlar okuyun.
DEPOSU
& Nbsp; kullanıcı ve depo adı, örneğin 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; GitHub uygulamanın istemci anahtar.
CLIENT_SECRET
& Nbsp; GitHub uygulamanın gizli anahtar.
SAVE_DIRECTORY
& Nbsp; dizinin yolunu verilerini depolamak için. Bu dizin bazı yapılandırılmış veriler, tar, ve inşa dokümantasyon saklar.
Secret_key
& Nbsp; gizli anahtar oturumları imzalamak için. Ayrıca oturumları hakkında Flask en dokümanlar bakın.
Açık kaynak
Okydoky Crosspop Hong Minhee tarafından yazılmıştır. Bu MIT lisansı altında dağıtılan, ve kaynak kodu GitHub deposunda bulunabilir. Ödeme:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git
Bu sürümde Yeni nedir:
- GitHub OAuth için zorladı. Bu izleyin.
sürüm 0.9.4 yeni nedir:
- setup.py için --upgrade seçeneği kullanın geliştirmek Komut. Bu bağımlılıkları sürümü çatışmaları önler.
- kurmak günlükleri build.txt dosyasında kalır.
sürüm 0.9.3 yeni nedir:
- Şimdi dizin sayfası refs listesini gösterir.
- Şimdi Okydoky setleri kendi oluşturma işlemi sırasında = 1 ortam değişkeni OKYDOKY. [# 5]
- Ekle / kafa özel ref url.
- kafa son ayarlı değil bir hata işlemek düzeltildi.
sürüm 0.9.2 yeni nedir:
- güvenlik hata düzeltildi: artık kullanıcıların olmalıdır bir depo için yetkilendirme. [# 4]
Gereksinimler :
- Python
Yorum Bulunamadı