Skip to content

Commit

Permalink
update yml docs
Browse files Browse the repository at this point in the history
  • Loading branch information
supernovahs committed May 11, 2024
1 parent e8cfacf commit 899c284
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
name: docs
name: Deploy docs to pages

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

permissions:
contents: read
pages: write
id-token: write

jobs:
build_docs:
Expand All @@ -19,9 +23,21 @@ jobs:
- name: Run tests
run: cargo test --verbose
- name: Generate documentation
run: cargo doc
run: cargo doc --no-deps --workspace
- name: Upload documentation
uses: actions/upload-artifact@v3
uses: actions/upload-pages-artifact@v3
with:
name: documentation
path: target/doc/**
path: target/doc/**

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build_docs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 899c284

Please sign in to comment.