Skip to content

docs-deploy

docs-deploy #583

Workflow file for this run

name: docs-deploy
on:
push:
paths:
- 'docs/**'
create:
tags:
- '*'
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: erpcya/sphinx-action@feature/#update-sphinx-base-image
with:
pre-build-command: "pip install sphinx_rtd_theme"
docs-folder: "docs/"
build-command: "sphinx-build -b html . _build/html"
- uses: erpcya/sphinx-action@feature/#update-sphinx-base-image
with:
pre-build-command: "pip install sphinx_rtd_theme"
docs-folder: "docs/"
build-command: "sphinx-build -b epub . _build/epub"
- name: Commit documentation changes
run: |
git clone https://github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages
cp -r docs/_build/html/* gh-pages/
cd gh-pages
touch .nojekyll
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore
# that.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}