Okydoky Geautomatiseerde documentenbuilder met behulp van Sphinx / Github / distribueren voor privégebruik
Download nu

Okydoky Rangschikking & Samenvatting

Okydoky Tags

Python bouwer documenten documenten bouwer SPHINX-documentatie

Okydoky Beschrijving

Okydoky is een geautomatiseerde documentatiebouwer met behulp van Sphinx, distribueren en Github (die Setuptools was). Het maakt uw gesloten Python-project om documentaties continu te bouwen, met de volgende aannames: 1. Documentatie gebeurt met SPHINX.2. Project is verpakt via SetUptools (niet PIPT, noch anderen) .3. Broncode wordt beheerd onder GitHub. Om te zeggen, het is gewoon een readdocsocs.org voor privégebruik. Hoe het werkt, werkt in de volgende instructies: 1. Wanneer nieuwe commits worden geduwd, triggt Github Okydoky na ontvangst haak.2. Okydoky downloadt Tarball-archieven van Pushed Commits van Github.3. Tarballarchief wordt geëxtraheerd in een tijdelijke map.4. SPHINX bouwt de documentatie op.5. Wanneer gebruikers de documenten aanvragen met behulp van hun webbrowser, vraagt Okydoky de gebruiker om te authenticeren met behulp van GitHub Oauth.6. Als ze de autorisatie heeft, dient Okydoky een gebouwde docs.how om het gewone python-pakket te gebruiken. U kunt het installeren met Easy_Install: Easy_Install Okydokythis-pakket biedt een opdrachtregel-script genaamd Okydoky. Het is een webtoepassing en ook een kleine webserver voor zichzelf. Het neemt een config-bestand. Config-bestanden moeten een aantal vereiste waarden bevatten zoals GitHub Application Key en Secret Key. U moet een GitHub-applicatie maken om Okydoky te gebruiken. De callback-URL is erg belangrijk. Vul het met: http: // / Auth / finalizeand vervangt met de domeinnaam wat u zult gebruiken. En voeg dan een haak na ontvangst toe in uw GitHub-repository: http: // / Als u een config-bestand maakt, voert u een Okydoky-server uit met Okydoky -H 0.0.0-P 8080 YECONFIG.PYLASTLY , je moet een initiële auth-auth-installatie maken. Open Http: // / in uw webbrowser en log in met GitHub vanaf daar. ConfiguratieHet configuratie is een normaal python-script. Het maakt gebruik van het configuratiesysteem van Fles. Lees de documenten van de fles over Config-bestanden.Repository De naam van de gebruiker en de repository b.v. 'CrossPop / Okydoky'.Client_ID de Client Key.Client_Secret van de Github-applicatie De geheime sleutel van de Github-applicatie.Save_Directory Het pad van de map om gegevens op te slaan. Deze map slaat enkele geconfigureerde gegevens, tarballs en gebouwde documentaties op .Secret_key de geheime sleutel om sessies te ondertekenen. Zie de documenten van de fles over sessies ook.Open Sourcokydoky is geschreven door Hong Minhee voor Crosspop. Het wordt verdeeld onder MIT-licentie en de broncode is te vinden in de GitHub-repository. Uitchecken: git clone git: //github.com/crosspop/Okydoky.gitproduct's startpagina

Okydoky Gerelateerde software