DOC-727: Convert Workflow reference to MD (#488) #157
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: Publish docs via GitHub Pages | |
on: | |
push: | |
branches: | |
- master | |
paths: | |
# Only rebuild website when docs have changed | |
# Comment out when testing locally via act! | |
- 'docs/**' | |
- 'examples/**' | |
- 'CHANGELOG.md' | |
- 'mkdocs.yml' | |
jobs: | |
build: | |
name: Deploy docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout master | |
uses: actions/checkout@v2 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v2 | |
with: | |
python-version: 3.8 | |
- name: Install dependencies | |
run: | | |
python -m pip install -r requirements-docs.txt | |
python -m pip install -e . | |
- name: Create symlinks for examples and changelog | |
run: | | |
ls | |
mkdir docs/examples | |
mv examples/* docs/examples | |
mv CHANGELOG.md docs | |
- name: Deploy docs | |
run: mkdocs gh-deploy --force -m "update gh-pages [ci skip]" |