Okydoky. Automated Docs Builder mit Sphinx / GitHub / Verteilen für den privaten Gebrauch
Jetzt downloaden

Okydoky. Ranking & Zusammenfassung

Okydoky. Stichworte

Python Erbauer Unterlagen Dokumentenersteller Sphinx-Dokumentation.

Okydoky. Beschreibung

Okydoky ist ein automatisierter Dokumentationsbauer mit Sphinx, Verteilen und Github (das Setuptools). Es macht Ihr geschlossenes Python-Projekt, die Dokumentationen kontinuierlich aufzubauen, mit den folgenden Annahmen: 1. Die Dokumentation erfolgt mit SPHINX.2. Das Projekt ist durch Setuptools (nicht Pip noch andere) verpackt .3. Quellcode wird unter Github verwaltet. Um in Kürze zu sagen, ist es einfach ein ReadThEdocs.org für den privaten Gebrauch. Wie funktioniert es funktionsfähig in den folgenden Anweisungen: 1. Wenn neue Commits gedrückt werden, löst Github Okydoky Post-Accough-Haken ab. Okydoky downloads Tarball-Archive von geschobenen Commits von Github.3. Das Tarball-Archiv wird in ein temporäres Verzeichnis extrahiert.4. Sphinx baut die Dokumentation.5. Wenn Benutzer die Dokumente mit ihrem Webbrowser anfordern, fragt OkyDOKY den Benutzer, sich mit Github OAuth zu authentifizieren.6. Wenn sie die Autorisierung haben, serviert okydoky einen eingebauten docs.Wie zu Verwendung eines normalen Python-Pakets. Sie können es mit EASY_INSTALL installieren: easy_install okydokythis-Paket bietet ein Befehlszeilen-Skript namens okydoky. Es ist eine Webanwendung und auch ein kleiner Webserver für sich. Es ist eine Konfigurationsdatei. Die Rückruf-URL ist sehr wichtig. Füllen Sie es mit: http: // / auth / calized ersetzt mit dem Domainnamen, was Sie verwenden werden. Fügen Sie dann einen Post-Empfangshaken in Ihr GITHUB-Repository hinzu: http: // / Wenn Sie eine Konfigurationsdatei erstellen, führen Sie einen OkyDoky-Server mit OKYDOKY-Skript aus: Okydoky -H 0.0.0.0-P 8080 YourConfig.Pylrastly , müssen Sie eine anfängliche Auth erstellen, um die Installation zu beenden. Öffnen Sie http: // / in Ihrem Webbrowser und loggen Sie sich mit GitHub von dort an. Konfigurieren Sie die Konfigurationsdatei ein normales Python-Skript. Es verwendet das Config-System von FLASH. Lese-FLASCHE-Dokumente über Konfigurationsdateien.Repository Der Benutzer- und Repository-Name z. 'crosspop / okydoky'.client_id Die Github-Anwendungs-Client-Key.client_secret Die Github-Anwendungs-Geheimschlüssel-Key.Save_Directory Der Pfad des Verzeichnisses zum Speichern von Daten. Dieses Verzeichnis speichert einige konfigurierte Daten, Taräler und erstellt documentations.secret_key der geheime Schlüssel, um Sessions zu unterzeichnen. Siehe FLASK-Dokumente über Sitzungen auch. Open Sourceokydoky wird von Hong Minhee für Crosspop geschrieben. Es ist unter MIT-Lizenz verteilt, und der Quellcode finden Sie im Github-Repository. Check out: Git Clone Git: //github.com/crossPop/okydoky.gitproduct's Homepage

Okydoky. Zugehörige Software