Okydoky yra automatinis dokumentų statybininkas naudojant Sfinksas, platinti ir GitHub (kuris buvo setuptools) & nbsp; Tai daro savo uždarytą Python projektą nuolat kurti dokumentacijas, su šiomis prielaidomis.:
1. Dokumentai yra atliekamas naudojant Sfinksas.
2. Projekto supakuotas per setuptools (ne pip, nei kiti).
3. Originalus kodas yra valdoma pagal GitHub.
Pasakyti netrukus, tai tiesiog asmeniniam naudojimui ReadTheDocs.org.
Kaip tai veikia
Jis veikia šiuos nurodymus:
1. Kai naujos commits yra stumiama, GitHub sukelia Okydoky po gauna kablys.
2. Okydoky parsisiųsti archyvą archyvus stumiama įsipareigoja iš GitHub.
3. tar archyvas gauna išgauti į laikiną katalogą.
4. Sfinksas stato dokumentus.
5. Kai vartotojai prašyti dokumentų naudojant savo naršyklę, Okydoky prašo vartotoją autentifikuoti naudojant GitHub OAuth ".
6. Jei jie turi leidimą, Okydoky tarnauja įmontuotą docs.
Kaip naudoti "
Tai paprastas Python paketas. Jūs galite įdiegti ją naudojant easy_install:
& Nbsp; easy_install Okydoky
Šis paketas suteikia komandinės eilutės scenarijų, pavadintą okydoky. Tai interneto paraišką, taip pat mažas žiniatinklio serveris pats už save. Tai užtrunka konfigūracijos failą.
Config failai turi būti tam tikras reikalingas vertybes kaip GitHub paraiškos klavišą ir slaptu raktu.
Jūs turite sukurti GitHub prašymą naudoti Okydoky. Jo skambutis URL yra labai svarbus. Užpildykite jį su:
http: //
ir pakeičia
http: //
Jei padarote config failą, tada paleisti Okydoky serverį naudojant okydoky scenarijų:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Galiausiai, jūs turite padaryti pradinį auth baigti diegimą. Atviras http: //
Sąranka "
Config failas yra normalu Python scenarijų. Jis naudoja kolbos konfigūracijos sistemą. Skaityti kolbos docs apie konfigūracijos failus.
Saugykla
& Nbsp; naudoti ir saugykla vardas pvz "Crosspop / okydoky".
CLIENT_ID
& Nbsp; GitHub Taikomosios programos klientas raktas.
CLIENT_SECRET
& Nbsp; GitHub Taikomosios programos slaptas raktas.
SAVE_DIRECTORY
& Nbsp; iš katalogo kelias saugoti duomenis. Šis katalogas bus saugomi kai sukonfigūruotas duomenų, archyvus, ir pastatyti dokumentacijas.
SECRET_KEY
& Nbsp; slaptas raktas pasirašyti sesijas. Žr kolbos docs apie sesijas, taip pat.
Atvirojo kodo
Okydoky parašyta Hong Minhee už Crosspop. Jis platinamas pagal MIT licencija ir kodo galima rasti GitHub saugykloje. Išvykimo data:
& Nbsp; git klonas git: //github.com/crosspop/okydoky.git
Kas naujo , šioje laidoje:
- GitHub priversti valstybę "OAuth". Sekite, kad.
Kas naujo versijos 0.9.4:
- Naudoti --upgrade parinktį setup.py plėtoti komanda. Tai apsaugo versija konfliktus priklausomybių.
- Sudėjimas rąstai liko build.txt failą.
Kas naujo 0.9.3 versija:
- Dabar Pagrindinis diskusijų puslapis rodo refs sąrašą.
- Dabar Okydoky rinkiniai OKYDOKY = 1 aplinkos kintamąjį jo statyti proceso metu. [# 5]
- Pridėti / head ypatingą teisėjas URL.
- Fiksuotas klaidą, kad vadovas nėra nustatytas vėliau įsipareigoti.
Kas naujo versijos 0.9.2:
- Fiksuotas saugumo klaidą: dabar vartotojai turi leidimas saugykloje. [# 4]
Reikalavimai :
- Python
Komentarai nerastas