本稿は Qiita 投稿記事 のバックアップです．

概要

ちょろっと調べた限り良さそうなものが無かったので， SphinxドキュメントをコンパイルするWercker step jkawamoto/sphinxを作った．

使い方

jkawamoto/sphinx step の実行には，pip が必要です．wercker.yml の steps に

- install-packages:
    packages: python-pip

を追加するか，box に jkawamoto/ghp-box を使ってください．

jkawamoto/sphinx step には，次のオプションがあります．

• target: make コマンドのターゲット (デフォルトは html)．
• basedir: Makefile があるディレクトリのパス．
• packages: 空白区切の Sphinx の実行に必要な PyPi パッケージリスト．使用するテーマなどを渡す．
• options: make コマンドに渡すオプション引数．

なお，リポジトリに requirements.txt が含まれている場合， 自動で pip install -r requirements.txt するので， 依存ライブラリを packages に含める必要はありません．

例

dsargparse で実際に使用している例は次の通り．

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