docs progress, api docs #3
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: Build Jekyll site | |
on: | |
push: | |
branches: ["master", "docs"] | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
# Build the cargo docs | |
- uses: actions-rust-lang/setup-rust-toolchain@v1 | |
with: | |
toolchain: nightly-2023-10-05 | |
- name: Generate Cargo Docs | |
run: cargo doc --no-deps | |
- name: Copy Cargo Docs to Jekyll source | |
run: cp -R target/doc docs/api | |
# Setup Github Pages | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Build | |
uses: actions/jekyll-build-pages@v1 | |
with: | |
source: ./docs | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
deploy: | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} |