Update installation instructions #236
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: update the gh-pages branch | |
on: | |
workflow_dispatch: # Allows you to run this workflow manually from the Actions tab | |
push: | |
branches: [main] | |
pull_request: | |
branches: [main] | |
jobs: | |
build-doc: | |
runs-on: ubuntu-latest # Easy to use GitHub hosted runner, self hosted runner would require manual configurations | |
steps: | |
- uses: actions/checkout@v2 # Checks out your repository under $GITHUB_WORKSPACE, so your job can access it | |
- name: Build Sphinx documentation | |
uses: ammaraskar/sphinx-action@master | |
with: | |
docs-folder: "docs/" | |
# Publish built docs to gh-pages branch. | |
# =============================== | |
- name: Commit documentation changes | |
run: | | |
git clone https://github.com/Aalto-Electric-Drives/motulator.git --branch gh-pages --single-branch gh-pages | |
cp -r docs/build/html/* gh-pages/docs | |
cd gh-pages | |
touch docs/.nojekyll | |
git config --local user.email "action@github.com" | |
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 }} | |
# =============================== |