Merge pull request #3 from Marley-Mulvin-Broome/wordtype #22
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: Create docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- "src/**" | |
- ".github/workflows/docs.yaml" | |
- "README.md" | |
permissions: | |
contents: write | |
jobs: | |
build-and-deploy: | |
concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession. | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout 🛎️ | |
uses: actions/checkout@v3 | |
- name: Setup Python 🐍 | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install Python Dependencies 📦 | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r dev_requirements.txt | |
- name: Build 🔧 | |
run: | | |
./docs.sh | |
- name: Deploy 🚀 | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: gh-pages # The branch the action should deploy to. | |
folder: docs # The folder the action should deploy. | |
target-folder: 'docs/' | |
commit-message: "Docs: ${{ github.sha }}" # The commit message for the deployment. |