Compiling a Sphinx document on Wercker
After import your repository, application page looks like this. Move on the workflow tab.
Open configuration of the
In the configuration of the build pipeline, scroll down to Permission level.
execute pipeline in order to prevent someone starting pipeline and see detailed logs.
gh-pages to Ignore branches so that Wercker will not start building documents after pushing to
Then, back to the workflow tab and add a new pipeline.
Now, we name the new pipeline
deploy, and hook type should be default to be chained to the build pipeline.
In order to push built documents to GitHub, this pipeline should know an access token of GitHub.
Add such key with name
GIT_TOKEN and protected option in the environment variables section of
The token can be obtained in https://github.com/settings/tokens.
If your repository is public, you only need a token with
public_repo scope. Otherwise, you may need a token with
GIT_TOKEN, check Permission level is Execute pipelines.
Next, make a workflow connecting the
deploy pipeline to the
build one in Workflow tab. Make sure this workflow only runs on master branch.
In the end, the workflow looks like the followings.
Next, you need to add
wercker.yml in your branch root.
You use Sphinx to build documents of which sources are in
wercker.yml may be there.
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
It also specifies to install
sphinx_rtd_theme. Make sure after running
make html in
doc folder, your documents are in
docs/build/html. Otherwise, edit
basedir in the last line.