diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..c9d1806 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,40 @@ +name: Publish Documentation + +on: + # Trigger the workflow on pushes to the main branch + push: + branches: + - main + + # Allows you to manually trigger the workflow from GitHub + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + + steps: + # Checkout the repository code + - name: Checkout code + uses: actions/checkout@v3 + + # Install Rust (default target is fine here) + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + override: true + + # Build the documentation + - name: Build documentation + run: cargo doc --no-deps + + # Deploy to gh-pages branch + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./target/doc + publish_branch: gh-pages + allow_empty_commit: true