Okydoky

Okydoky is een geautomatiseerde documentatie bouwer met behulp van Sphinx, verspreiden en GitHub (die setuptools was) & nbsp; Het maakt je gesloten Python project om continu te bouwen documentatie, met de volgende veronderstellingen.:
1. Documentatie wordt gedaan met behulp van Sphinx.
2. Project wordt verpakt door setuptools (niet pip noch enige andere).
3. Broncode wordt beheerd onder GitHub.
Om kort te zeggen, het is gewoon een ReadTheDocs.org voor privé-gebruik.
Hoe werkt het?
Het werkt in de volgende instructies:
1. Wanneer nieuwe commits worden geduwd, GitHub triggers Okydoky post-receive haak.
2. Okydoky downloads tarball archieven van geduwd commits van GitHub.
3. Tarball archief wordt uitgepakt in een tijdelijke directory.
4. Sphinx bouwt de documentatie.
5. Wanneer gebruikers vragen de docs met behulp van hun webbrowser, Okydoky vraagt ​​de gebruiker te authenticeren met behulp van GitHub OAuth.
6. Als ze heeft de machtiging, Okydoky serveert een ingebouwde docs.
Hoe te gebruiken
Het is een gewone Python pakket. U kunt het installeren met behulp van easy_install:
& Nbsp; easy_install Okydoky
Dit pakket bevat een command line script genaamd okydoky. Het is een web-applicatie en ook een kleine webserver voor zichzelf. Het duurt een config file.
Configuratiebestanden moeten een aantal vereiste waarden zoals GitHub applicatie sleutel en geheime sleutel bevatten.
Je moet een GitHub applicatie om Okydoky gebruik te maken. De verificatie-URL is erg belangrijk. Vul het met:
http: // / auth / finalize
en vervangt met de domeinnaam wat je zult gebruiken. En dan, voeg een post-receive haak in uw GitHub repository:
http: // /
Als u een configuratiebestand te maken, voer vervolgens een Okydoky server met okydoky script:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Ten slotte moet je een eerste auth om de installatie af te maken. Open http: // / in uw webbrowser en log in met GitHub vanaf daar.
Configuratie
Het configuratiebestand is een normale Python-script. Het maakt gebruik van Kolf's config-systeem. Lees Kolf's docs over configuratiebestanden.
REPOSITORY
& Nbsp; De gebruiker en repository naam bijv. 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; client-toets De GitHub toepassing.
CLIENT_SECRET
& Nbsp; geheime sleutel De GitHub toepassing.
SAVE_DIRECTORY
& Nbsp; Het pad van de directory om gegevens op te slaan. Deze map zal een aantal geconfigureerde gegevens, tarballs, en bouwde documentatie op te slaan.
SECRET_KEY
& Nbsp; De geheime sleutel om sessies te ondertekenen. Zie docs Kolf's over sessies ook.
Open source
Okydoky is geschreven door Hong Minhee voor Crosspop. Het wordt gedistribueerd onder MIT licentie, en de broncode is te vinden in de GitHub repository. Check out:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Wat is nieuw in deze release:

• GitHub gedwongen staat voor OAuth. Volg dat.

Wat is nieuw in versie 0.9.4:

• Gebruik --upgrade optie voor setup.py ontwikkelen commando. Dit voorkomt versie conflicten van afhankelijkheden.
• Build logs worden achtergelaten in de build.txt bestand.

Wat is nieuw in versie 0.9.3:

• Nu is de index pagina toont de lijst van de refs.
• Nu Okydoky sets OKYDOKY = 1 omgevingsvariabele tijdens het bouwproces. [# 5]
• Add / head speciale referentie url.
• Fixed a bug die het hoofd niet is ingesteld op de laatste commit.

Wat is nieuw in versie 0.9.2:

• Fixed a security bug: nu gebruikers moeten beschikken over een toestemming voor de repository. [# 4]

Eisen

• Python