Docs tweaks; add instructions for firmware development #67
Workflow file for this run
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 Docs Site | |
on: | |
push: | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
- '.github/workflows/deploy-pages.yml' | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build: | |
name: "Build MkDocs static site" | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Setup MkDocs | |
run: pip install -r docs/requirements.txt | |
- name: Run MkDocs | |
run: | | |
mkdir -p build/docs | |
mkdocs build | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: 'build/docs' | |
deploy: | |
needs: [ build ] | |
if: github.ref == 'refs/heads/main' | |
name: "Deploy content to GitHub Pages" | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup Pages | |
uses: actions/configure-pages@v3 | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |