Okydoky

Okydoky ay isang automated tagabuo ng dokumentasyon gamit ang Sphinx, Ipamahagi at GitHub (na noon ay setuptools) & nbsp; Ito ay gumagawa ng iyong proyekto sarado Python upang patuloy na bumuo ng documentations, na may sumusunod na mga pagpapalagay.:
1. Documentation ay tapos na gamit ang Sphinx.
2. Project ay naka-package na sa pamamagitan ng setuptools (hindi buto ng bungang-kahoy o anumang iba).
3. Ang source code ay pinamamahalaan sa ilalim ng GitHub.
Upang sabihin sa ilang sandali, ito ay isang ReadTheDocs.org para sa pribadong paggamit lamang.
Paano ito gumagana
Ito ay gumagana sa mga sumusunod na tagubilin:
1. Kapag bagong gumawa ay matutulak, GitHub trigger Okydoky post-hook makatanggap.
2. Okydoky download tarball mga archive ng matutulak gumawa mula sa GitHub.
3. Tarball archive ay makakakuha ng kinuha sa isang pansamantalang direktoryo.
4. Sphinx build ang dokumentasyon.
5. Kapag humiling ng mga gumagamit ng docs gamit ang kanilang web browser, itatanong Okydoky user upang patotohanan ang mga gumagamit ng GitHub OAuth.
6. Kung sila ay may pahintulot, naghahain Okydoky isang built doc.
Paano gamitin ang
Ito ay isang ordinaryong pakete Python. Maaari mo itong i-install gamit ang easy_install:
& Nbsp; easy_install Okydoky
Ang paketeng ito ay nagbibigay ng isang script na linya ng command na tinatawag na okydoky. Ito ay isang web application at isang maliit na web server para sa sarili din. Ito ay tumatagal ng isang config file.
Config file ay kailangang maglaman ng ilang mga kinakailangang mga halaga tulad ng GitHub key application at lihim na key.
Mayroon kang lumikha ng isang GitHub application upang gamitin Okydoky. Nito callback URL ay napakahalaga. Punan ito sa:
http: // / auth / i-finalize ang
at pumapalit na may domain name kung ano ang gagamitin mo. At pagkatapos, magdagdag ng isang post-makatanggap hook in sa iyong GitHub imbakan:
http: // /
Kung gumawa ka ng config file, pagkatapos ay magpatakbo ng isang Okydoky server gamit ang okydoky script:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Panghuli, kailangan mong gumawa ng isang paunang auth upang tapusin ang pag-install. Buksan ang http: // / sa iyong web browser at mag-login sa GitHub mula doon.
Configuration
Ang config file ay isang normal na Python script. Ito ay gumagamit ng config sistema ng prasko. Basahin ang prasko ni doc tungkol sa config file.
Repositoryo
& Nbsp; Ang pangalan ng gumagamit at imbakan hal 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; client susi GitHub application.
CLIENT_SECRET
& Nbsp; sikretong key Ang GitHub application.
SAVE_DIRECTORY
& Nbsp; Ang path ng direktoryo upang mag-imbak ng data. Direktoryong ito mag-iimbak ang ilang mga naisaayos na data, tarballs, at built documentations.
SECRET_KEY
& Nbsp; Ang lihim na key upang mag-sign session. Tingnan ang mga doc prasko tungkol sa mga session din.
Buksan ang pinagmulan
Okydoky ay nakasulat sa pamamagitan ng Hong Minhee para sa Crosspop. Ito ay ipinamamahagi sa ilalim ng MIT lisensya, at ang source code ay matatagpuan sa GitHub imbakan. Tingnan ang:
& Nbsp; Git clone ng Git: //github.com/crosspop/okydoky.git

Ano ang bagong sa paglabas:

• GitHub sapilitang estado para sa OAuth. Sundin na iyon.

Ano ang bagong sa bersyon 0.9.4:

• Gamitin --upgrade na pagpipilian para sa setup.py bumuo ng command. Pinipigilan nito ang mga salungatan bersyon ng dependency.
• Bumuo log natitira sa build.txt file.

Ano ang bagong sa bersyon 0.9.3:

• Ngayon ang pahina ng index ay ipinapakita ang listahan ng mga refs.
• Ngayon Okydoky mga hanay ng OKYDOKY = 1 environment variable sa panahon ng proseso ng pag-build nito. [# 5]
• Magdagdag / head espesyal ref url.
• Ang Nakatakdang ng isang bug na ang ulo ay hindi nakatakda sa pinakabagong gumawa.

Ano ang bagong sa bersyon 0.9.2:

• Ang Nakatakdang isang bug sa seguridad: ngayon ay dapat na magkaroon ng isang user -debit para sa imbakan. [# 4]

Mga Kinakailangan :

• Python