[PYTHON] Étape Wercker pour compiler la documentation Sphinx

Aperçu

Autant que je l'ai recherché, il n'y avait rien qui avait l'air bien, alors Sphinx Compilez le document Wercker step [jkawamoto / sphinx](https://github.com / jkawamoto / wercker-sphinx-step) a été créé.

Comment utiliser

Pip est requis pour exécuter l'étape jkawamoto / sphinx. Dans les étapes de wercker.yml

- install-packages:
    packages: python-pip

Ou utilisez jkawamoto / ghp-box dans la boîte.

L'étape jkawamoto / sphinx a les options suivantes:

--target: Cible de la commande make (la valeur par défaut est html). --basedir: Le chemin du répertoire où se trouve Makefile. --packages: liste séparée par des blancs des packages PyPi nécessaires pour exécuter Sphinx. Passez le thème à utiliser. --options: arguments facultatifs à transmettre à la commande make.

Si le référentiel contient requirements.txt, Il sera automatiquement pip install -r requirements.txt, donc Les bibliothèques dépendantes n'ont pas besoin d'être incluses dans les packages.

Exemple

L'exemple réellement utilisé dans dsargparse est le suivant.

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