ebcd26fd51
* Update `xtask` dependencies * Update `xtask` to support generating documentation for multiple chips * Update CI and Documentation workflows * Fix minor mistake in documentation index template
51 lines
1.3 KiB
YAML
51 lines
1.3 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: esp-rs/xtensa-toolchain@v1.5
|
|
with:
|
|
default: true
|
|
ldproxy: false
|
|
|
|
- name: Build documentation
|
|
run: cargo xtask build-documentation --packages=esp-hal,esp-wifi
|
|
|
|
# https://github.com/actions/deploy-pages/issues/303#issuecomment-1951207879
|
|
- name: Remove problematic '.lock' files
|
|
run: find docs -name ".lock" -exec rm -f {} \;
|
|
|
|
- name: Upload Pages artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: "docs"
|
|
|
|
deploy:
|
|
# Add a dependency to the build job:
|
|
needs: build
|
|
|
|
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment:
|
|
permissions:
|
|
pages: write # to deploy to Pages
|
|
id-token: write # to verify the deployment originates from an appropriate source
|
|
|
|
# Deploy to the github-pages environment:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
# Specify runner + deployment step:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|