Okydoky

Okydoky egy automatizált dokumentációt készítő segítségével Szfinx, terjeszthető és GitHub (ami setuptools). & Nbsp; Lehetővé teszi a zárt Python projekt folyamatosan építik dokumentációk, a következő feltételezések:
1. Dokumentáció használatával történik Sphinx.
2. A projekt csomagolják át setuptools (nem pip sem mások).
3. A forráskód keretében kezelt GitHub.
Ha azt mondjuk, nem sokkal, ez egyszerűen egy ReadTheDocs.org magáncélú felhasználásra.
Hogyan működik
Úgy működik, a következő utasításokat:
1. Ha az új véglegesítésekhez tolják, GitHub kiváltja Okydoky utáni kapnak horog.
2. Okydoky letöltések tarlabda levéltárában tolta vállalkozik a GitHub.
3. tarlabda archívum lesz kitermelt egy ideiglenes könyvtárba.
4. Sphinx épít a dokumentáció.
5. Amikor a felhasználók a docs segítségével a böngésző, Okydoky kéri a felhasználót, hogy hitelesítse a GitHub OAuth.
6. Ha nak joga van, Okydoky szolgál a beépített docs.
Hogyan használd
Ez egy közönséges Python csomagot. Akkor telepítenie kell easy_install:
& Nbsp; easy_install Okydoky
Ez a csomag egy parancssori szkript, okydoky. Ez egy webes alkalmazás, és még egy kis webszerver magának. Beletelik egy config fájlt.
Config fájlok tartalmaznak néhány szükséges értékek, mint a GitHub alkalmazás és titkos kulcsot.
Akkor létre kell hozni egy GitHub alkalmazást Okydoky. A visszahívás URL nagyon fontos. Töltsd ki:
http: // / auth / finalize
és felváltja a domain nevet fogja használni. És akkor, adjunk hozzá egy poszt-megkapják horgot a GitHub repository:
http: // /
Ha egy config fájlt, majd futtasson egy Okydoky szerver segítségével okydoky script:
& Nbsp; okydoky H 0.0.0.0 -p 8080 yourconfig.py
Végül, van, hogy egy kezdeti auth telepítés befejezéséhez. Nyílt http: // / a böngészőjében, és jelentkezzen be GitHub onnan.
Configuration
A config file egy normális Python script. Ez használ lombik config rendszert. Olvassa lombik docs mintegy config fájlt.
Repository
& Nbsp; A felhasználó és adattár nevet, például "Crosspop / okydoky".
CLIENT_ID
& Nbsp; A GitHub alkalmazás kliens gombot.
CLIENT_SECRET
& Nbsp; A GitHub alkalmazás titkos kulcsot.
SAVE_DIRECTORY
& Nbsp; A mappa elérési útját az adatok tárolására. Ez a könyvtár tárolja néhány beállított adat, tarballs, és a beépített dokumentációkat.
SECRET_KEY
& Nbsp; A titkos kulcs aláírására ülés. Lásd lombik docs munkamenetekről is.
Open source
Okydoky írta Hong Minhee a Crosspop. Ez alatt terjesztett MIT licenc és a forráskódot megtalálható a GitHub repository. Nézze meg:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Mi az új ebben a kiadásban:

• GitHub kénytelen állapotban OAuth. Kövesse ezt.

Mi az új verzióban 0.9.4:

• A --upgrade lehetőség setup.py fejlesztése parancsot. Ez megakadályozza verziója konfliktusok függőségek.
• Építsd naplók sem maradt a build.txt fájlt.

Mi az új verzióban 0.9.3:

• Most az index oldalon listáját mutatja, bíró.
• Most Okydoky készletek OKYDOKY = 1 környezeti változó során fordítást. [# 5]
• Add / head speciális ref url.
• Javítva egy hiba, amely a fej nincs beállítva a legújabb elkövetni.

Mi az új verzióban 0.9.2:

• Javítva egy biztonsági hiba: A felhasználók most kell egy engedélyt a tárolóból. [# 4]

követelmények :

• Python