[PYTHON] Wercker Schritt zum Kompilieren der Sphinx-Dokumentation

Überblick

Soweit ich es nachgeschlagen habe, gab es nichts, was gut aussah Sphinx Kompilieren Sie das Dokument Wercker Schritt [jkawamoto / sphinx](https://github.com / jkawamoto / wercker-sphinx-step) wurde erstellt.

Wie benutzt man

"Pip" ist erforderlich, um den Schritt "jkawamoto / sphinx" auszuführen. In Schritten von wercker.yml

- install-packages:
    packages: python-pip

Oder verwenden Sie jkawamoto / ghp-box in der Box.

Der Schritt "jkawamoto / sphinx" bietet die folgenden Optionen:

--target: Ziel des Befehls make (Standard ist "html"). --basedir: Der Pfad des Verzeichnisses, in dem sich Makefile befindet. --packages: Durch Leerzeichen getrennte Liste der PyPi-Pakete, die zum Ausführen von Sphinx benötigt werden. Übergeben Sie das zu verwendende Thema. --options: Optionale Argumente, die an den Befehl make übergeben werden sollen.

Wenn das Repository "require.txt" enthält, Es wird automatisch pip install -r require.txt, also Abhängige Bibliotheken müssen nicht in "Paketen" enthalten sein.

Beispiel

Das in dsargparse tatsächlich verwendete Beispiel lautet wie folgt.

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