Okydoky

Okydoky je automatizovaný dokumentace stavitel pomocí Sphinx, distribuovat a GitHub (což bylo setuptools) & nbsp; to je vaše uzavřený projekt Python neustále stavět dokumentace, na základě těchto předpokladů.:
1. Dokumentace se provádí pomocí Sphinx.
2. Projekt je zabalen do setuptools (ne pip ani žádné jiné).
3. Zdrojový kód je spravován pod GitHub.
Chcete říct, krátce, je to prostě ReadTheDocs.org pro soukromé použití.
Jak to funguje
Pracuje v následujících pokynů:
1. Pokud se noví nezavazuje tlačil, GitHub spustí Okydoky post-příjem háček.
2. stahování Okydoky archiv s archivy tlačil commitů z GitHub.
3. archiv tarball dostane extrahuje do dočasného adresáře.
4. Sphinx staví dokumentaci.
5. Když uživatelé požadovat dokumenty pomocí webového prohlížeče, Okydoky žádá uživatele, aby ověření pomocí GitHub OAuth.
6. Pokud má povolení, Okydoky slouží vestavěné dokumenty.
Jak používat
Je to obyčejný Python balíček. Můžete jej nainstalovat pomocí easy_install:
& Nbsp; easy_install Okydoky
Tento balíček obsahuje skriptu příkazového řádku s názvem okydoky. Je to webová aplikace a také malý webový server pro sebe. Trvá konfigurační soubor.
Konfigurační soubory musí obsahovat některé požadované hodnoty, jako je GitHub klíče aplikací a tajného klíče.
Musíte vytvořit aplikaci, GitHub použít Okydoky. Jeho Callback URL je velmi důležité. Naplňte ji:
http: // / auth / finalizace
a nahrazuje s názvem domény, co budete používat. A pak, přidejte post-příjem hák do repozitáře GitHub:
http: // /
Pokud uděláte konfigurační soubor, a pak spustit Okydoky serveru pomocí okydoky skript:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
A konečně, musíte provést prvotní autentizaci na dokončení instalace. Otevřeno http: // / ve Vašem webovém prohlížeči a přihlásit se GitHub odtud.
Configuration
Konfigurační soubor je normální Python skript. Používá konfigurační systém baňka se. Přečtěte si baňka Docs o konfigurační soubory.
ÚLOŽIŠTĚ
& Nbsp; uživatel a úložiště jméno např. "Crosspop / okydoky".
CLIENT_ID
& Nbsp; klient klíč The GitHub aplikace.
CLIENT_SECRET
& Nbsp; tajný klíč The GitHub aplikace.
SAVE_DIRECTORY
& Nbsp; cesta k adresáři pro ukládání dat. Tento adresář bude ukládat nějaké data konfigurace, archivů a vystavěl dokumentace.
SECRET_KEY
& Nbsp; tajný klíč k podpisu relací. Viz dokumenty baňka je o zasedání také.
Open source
Okydoky je napsána Hong Minhee pro Crosspop. Je šířen pod licencí MIT, a zdrojový kód lze nalézt v úložišti GitHub. Zkontroluj:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Co je nového v této verzi:

• GitHub nucen stát na OAuth. Sledujte to.

Co je nového ve verzi 0.9.4:

• Použít --upgrade možnost setup.py rozvíjet příkaz. Tím se zabrání konflikty verzí k závislostem.
• Build protokoly jsou ponechány v souboru build.txt.

Co je nového ve verzi 0.9.3:

• Nyní stránka index zobrazuje seznam ref.
• Nyní Okydoky sady OKYDOKY = proměnné 1 životní prostředí během procesu sestavení. [# 5]
• Přidat / head speciální ref url.
• Opravena chyba, že hlava není nastaven na poslední spáchat.

Co je nového ve verzi 0.9.2:

• Opravena bezpečnostní chyba: nyní uživatelé musí mít oprávnění pro úložiště. [# 4]

Požadavky na :

• Python