Okydoky

Okydoky on automatisoitu asiakirjat rakentaja käyttäen sfinksi, levittää ja GitHub (joka oli setuptools). & Nbsp; Se tekee suljettu Python projektin jatkuvasti rakentaa dokumentaatiot, seuraavia oletuksia:
1. Asiakirjat on tehty käyttäen sfinksi.
2. Hankkeen on pakattu kautta setuptools (ei pip eikä muita).
3. Lähdekoodi hallinnoidaan GitHub.
Sanoa pian, se on yksinkertaisesti ReadTheDocs.org yksityiskäyttöön.
Miten se toimii
Se toimii seuraavat ohjeet:
1. Kun uusi arkistotoimituksiin työnnetään, GitHub laukaisee Okydoky jälkeisen saavat koukku.
2. Okydoky lataukset tarrapallon arkistojen työnsi arkistotoimituksiin alkaen GitHub.
3. tarpaketin arkisto saa uuttaa väliaikaiseen hakemistoon.
4. Sphinx rakentaa asiakirjat.
5. Kun käyttäjät pyytää dokumentit käyttämällä selaimen Okydoky pyytää käyttäjää todentamaan käyttäen GitHub OAuth.
6. Jos ne on lupa, Okydoky palvelee rakennettu docs.
Miten käyttää
Se tavallinen Python paketti. Voit asentaa sen käyttämällä easy_install:
& Nbsp; easy_install Okydoky
Tämä paketti sisältää komentoriviltä script kutsutaan okydoky. Se on web-sovellus ja myös pieni web-palvelin itselleen. Se vie config-tiedosto.
Config-tiedostot täytyy sisältää joitakin tarvittavat arvot kuten GitHub sovelluksen näppäintä ja salainen avain.
Sinun täytyy luoda GitHub sovellus käyttää Okydoky. Sen Takaisinsoiton URL on erittäin tärkeää. Täytä se:
http: // / auth / Päätä
ja korvaa kanssa verkkotunnus, mitä tulet käyttämään. Ja sitten, lisää jälkeinen saada koukku omalle GitHub arkistoon:
http: // /
Jos teet config-tiedosto, suorita Okydoky palvelimelle okydoky kirjoitus:
& Nbsp; okydoky H 0.0.0.0 -p 8080 yourconfig.py
Lopuksi, sinun täytyy tehdä ensimmäinen auth loppuun asennuksen. Avaa http: // / selaimessasi ja kirjaudu sisään GitHub sieltä.
Asetukset
Config tiedosto on normaali Python skripti. Se käyttää kolvin config järjestelmää. Lue kolvin docs noin config-tiedostoja.
Repository
& Nbsp; Käyttäjä ja arkiston nimi esim "Crosspop / okydoky".
CLIENT_ID
& Nbsp; GitHub sovelluksen asiakkaan avain.
CLIENT_SECRET
& Nbsp; GitHub sovelluksen salainen avain.
SAVE_DIRECTORY
& Nbsp; polku hakemistoon tallentaa tietoja. Tämä hakemisto tallentaa joitakin konfigurointitietojen, paketit, ja rakennettu dokumentaatiot.
SECRET_KEY
& Nbsp; salainen avain allekirjoittaa istuntoja. Katso kolvin docs noin istuntoja myös.
Open source
Okydoky on kirjoittanut Hong Minhee varten Crosspop. Se levitetään MIT lisenssin, ja lähdekoodi löytyy GitHub arkistoon. Lähtö:
& Nbsp; git klooni git: //github.com/crosspop/okydoky.git

Mitä uutta tässä julkaisussa: