Okydoky

.

Okydoky Sphinx, yaymaq və GitHub (setuptools idi) & nbsp istifadə edərək, avtomatik sənədlər builder edir; Davamlı aşağıdakı fərziyyələr ilə sənədlərimi yaratmaq üçün bağlıdır Python layihə edir:
1. Documentation Sphinx istifadə edilir.
2. Layihənin (tırtıl, nə də hər hansı digər deyil) setuptools vasitəsilə paketlenmiş.
3. Source kodu GitHub altında idarə olunur.
Qısa desək, sadəcə şəxsi istifadə üçün ReadTheDocs.org var.
Bu Nasıl çalışır
Bu, aşağıdakı talimatları çalışır:
Yeni öhdəliyini sövq zaman 1. GitHub çəngəl-post almaq Okydoky tetikler.
2. Okydoky downloads GitHub sövq öhdəliyini arxiv tarball.
3. tarball arxivi müvəqqəti dizine hasil olur.
4. Sphinx sənədlərin qurur.
Istifadəçilər web browser istifadə edərək docs tələb 5., Okydoky GitHub OAuth istifadə kimlik istifadəçi soruşur.
Onlar icazə varsa 6. Okydoky daxili docs xidmət edir.
Necə istifadə
Bu adi Python paketi var. Siz easy_install istifadə edərək quraşdıra bilərsiniz:
& Nbsp; easy_install Okydoky
Bu paket okydoky adlı command line script edir. Bu web tətbiqi və həmçinin özü üçün kiçik web server var. Bu konfiqurasiya faylını edir.
Config faylları GitHub proqram əsas və gizli əsas kimi tələb olunan dəyərlər ehtiva edir.
Siz Okydoky istifadə etmək GitHub proqram yaratmaq lazımdır. Onun Callback URL çox vacibdir. Bu ilə doldurun:
http: // / İcazə / yekunlaşdırmaq
və əvəz istifadə lazımdır nə domen adı ilə. Və sonra, sizin GitHub depo bir post-qəbul çəngəl əlavə edin:
http: // /
Bir konfiqurasiya faylını etmək, onda okydoky script istifadə edərək Okydoky server run:
& Nbsp; okydoky -H 0.0.0.0 p 8080 yourconfig.py
Nəhayət, siz quraşdırma başa çatdırmaq üçün ilkin İcazə etmək lazımdır. Open http: // / web brauzerinizin və oradan GitHub ilə daxil.
Konfiqurasiya
config fayl normal Python script edir. Bu Flask nin config sistemindən istifadə edir. Config faylları haqqında Flask nin docs oxuyun.
Depo
& Nbsp; istifadəçi və depo adı məsələn "Crosspop / okydoky.
CLIENT_ID
& Nbsp; GitHub proqram müştəri düyməsini basın.
CLIENT_SECRET
& Nbsp; GitHub proqram gizli düyməsini basın.
SAVE_DIRECTORY
& Nbsp; kataloq yolu veri. Bu kataloq bəzi konfiqurasiya data, tarballs, və daxili sənədləri saxlamaq olacaq.
SECRET_KEY
& Nbsp; gizli əsas sessiyaları imzalayacaq. Də sessiyaların planı haqqında Flask nin docs baxın.
Açıq mənbə
Okydoky Crosspop üçün Hong Minhee tərəfindən yazılmışdır. Bu MIT lisenziyası əsasında paylanmış, və mənbə kodu GitHub depo tapa bilərsiniz. Edin:
& Nbsp; git klon git: //github.com/crosspop/okydoky.git

Bu azad Yeni nədir:

• GitHub OAuth üçün dövlət məcbur etdi. Ki, edin.

versiya 0.9.4 yeni nədir:

• setup.py üçün --upgrade seçimi istifadə edin inkişaf komanda. Bu asılılıqlar versiyası münaqişələrin qarşısını alır.
• Build logs build.txt fayl qalır.

versiya 0.9.3 yeni nədir:

• İndi index səhifə refs siyahısını göstərir.
• İndi Okydoky dəsti onun build zamanı = 1 mühit dəyişən OKYDOKY. [5]
• Əlavə et / baş xüsusi ref url.
• Baş son müəyyən deyil bir səhv törətmək Sabit.

versiya 0.9.2 yeni nədir:

• təhlükəsizlik səhv Sabit: İndi istifadəçilər olmalıdır bir deposu üçün icazə. [# 4]

tələblər

• Python