[PYTHON] Kompilieren Sie die Sphinx-Dokumentation mit Wercker
Überblick
Hier finden Sie eine Zusammenfassung der Einstellungen zum Kompilieren von Sphinx-Dokumenten mit Wercker mit Screenshots.
Verfahren
Importieren Sie das Ziel-Repository aus Erstellen → Anwendung von Wercker. Der Bildschirm nach dem Import sieht folgendermaßen aus. Wechseln Sie daher zur Registerkarte "Workflow".
Öffnen Sie von dort aus die Einstellungen für die Build-Pipeline.
Scrollen Sie durch den Einstellungsbildschirm für die Build-Pipeline, um das Element Berechtigungsstufe anzuzeigen.
Und die "Berechtigungsstufe" verhindert, dass andere die Pipeline ausführen. Wählen Sie außerdem "Pipeline ausführen", damit das Protokoll nicht unachtsam veröffentlicht wird. Fügen Sie außerdem "gh-Seiten" zu "Zweige ignorieren" hinzu. Wenn Sie dies vergessen, wird die Kompilierung erneut gestartet, nachdem Sie das Dokument auf "gh-pages" verschoben haben.
Kehren Sie anschließend zur Registerkarte Workflow zurück und erstellen Sie eine neue Pipeline.
Nennen Sie die neue Pipeline "deploy" und machen Sie den Hook-Typ zum Standard. Die Standardeinstellung ist die Einstellung für die Verbindung zur vorherigen Pipeline.
So laden Sie das kompilierte Dokument auf GitHub hoch Registrieren Sie das Zugriffstoken für GitHub als Umgebungsvariable in dieser Pipeline. Setzen Sie den Namen der Umgebungsvariablen auf "GIT_TOKEN" und aktivieren Sie die Option "protected".
GitHub-Token können unter https://github.com/settings/tokens bezogen werden. Für öffentliche Repositorys müssen Sie nur "public_repo" überprüfen. Bei privaten Repositorys müssen Sie möglicherweise "Repo" überprüfen (nicht ausprobiert).
Ändern Sie nach dem Hinzufügen der Umgebungsvariablen "GIT_TOKEN" die Berechtigungsstufe in "Pipelines ausführen" und erstellen Sie eine Pipeline.
Verbinden Sie als Nächstes die zuvor erstellte "Bereitstellungs" -Pipeline mit "Erstellen", um einen neuen Workflow zu erstellen. Bearbeiten Sie außerdem Ein Zweig (e) so, dass er nur funktioniert, wenn Sie ihn an den Master senden.
Schließlich sollte es wie folgt sein.
Fügen Sie schließlich wercker.yml zum Repository hinzu.
Wenn Sie beispielsweise die Quelle im Ordner "docs" mit Sphinx kompilieren, sieht die Datei "wercker.yml" folgendermaßen aus:
wercker.yml
box: jkawamoto/ghp-box
build:
steps:
- jkawamoto/sphinx:
basedir: docs
packages: sphinx_rtd_theme
deploy:
steps:
- jkawamoto/ghp-import:
token: $GIT_TOKEN
basedir: docs/build/html
In diesem Beispiel wird "sphinx_rtd_theme" verwendet.
Es wird davon ausgegangen, dass das kompilierte Dokument in "docs / build / html" generiert wird.
Wenn nicht, bearbeiten Sie basedir entsprechend Ihrer Umgebung.
Unten finden Sie eine Beschreibung der Felder und Schritte.
Recommended Posts