GHP-Import. Kopieren Sie Ihre Dokumente direkt in den GH-Pages-Zweig
Jetzt downloaden

GHP-Import. Ranking & Zusammenfassung

GHP-Import. Stichworte

importieren Unterlagen kopieren von Dokumenten GH-Pages-Niederlassung GH-Pages

GHP-Import. Beschreibung

Kopieren Sie Ihre Dokumente direkt in den GH-Pages-Zweig Als Teil von Gunicorn begann mich und Benoit Chesneau, anzumelden, wie Sie die Dokumentation veranstalten können. Es gibt die offensichtliche Methode, um Githubs Post-Update-Haken zu verwenden, um Doc-Builds und Rsync an einen Webserver auszulösen, aber wir wollten, dass Githubs Hosting das Github-Hosting aus ausprobieren wollte, um die gesamte Schnittstelle ein bisschen mehr robust zu machen. Die Github-Seiten ist ein ziemlich großartiger Service sorgt für das Hosting-Projektdokumentation. Das einzige ist, dass es einen GH-Pages-Zweig erfordert, der die Dokumententräger der Site ist. Dies bedeutet, dass das Halten von Dokumentationsquellen in der Niederlassung mit Code ein bisschen schwierig ist. Und es verwandelt sich wirklich in einen Kopfkratzer für Dinge wie Sphinx, die gleichzeitig auf Dokumentationsquellen und Codequellen zugreifen möchten. CommentumSthen, den ich über ein interessantes aussehendes Paket namens Github-Tools stolperte, das fast so aussah, wie ich wollte. Es war ein bisschen kompliziert und mehr Beteiligte als ich wollte, aber es gab mir eine Idee. Wählen Sie nicht nur ein Skript, mit dem ein Verzeichnis in den Zweig des GH-Seiten des Repositorys kopieren kann. Das spart mich davon ab, über den Zweig nachdenken zu müssen, und alles wird magisch. Daher wurde Ghp-Import erstellt.Big Fat WaringThis wird Ihren GH-Pages-Zweig zerstören. Wenn Sie es lieben, möchten Sie Backups nehmen, bevor Sie damit spielen. Dieses Skript geht davon aus, dass GH-Seiten 100% derivat ist. Sie sollten keine Dateien in Ihrem GH-Pages-Zweig mit Hand bearbeiten, wenn Sie dieses Skript verwenden, weil Sie Ihre Arbeit verlieren -Pageszweig. -P drücken Sie den Zweig auf Ursprungs- / GH-Seiten nach dem Bekämpfen. -r Remote Der Name der Fernbedienung, um zu drücken. -h, --help Zeigen Sie diese Hilfsnachricht und stößt ziemlich einfach aus. In Ihrem Repository führen Sie den GHP-Import $ docs_dir aus, wo $ docs_dir der Pfad zur ergebenden Dokumentation ist. Dadurch wird ein Commit für Ihren GH-Pages-Zweig mit den aktuellen Dokumenten darin schreiben. Wenn Sie angeben, wird es auch versuchen, den GH-Pages-Ast an GitHub zu drücken. Standardmäßig läuft es nur Git Push Origin GH-Seiten. Sie können mit der -R-Flag eine andere Fernbedienung angeben. Anforderungen: · Python

GHP-Import. Zugehörige Software