Use full names for some types in readme #32
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: Documentation | |
on: | |
push: | |
branches: [main] | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: deploy | |
cancel-in-progress: false | |
jobs: | |
build-docs: | |
name: Build docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install Rust stable | |
uses: dtolnay/rust-toolchain@stable | |
- name: Setup Cargo dependency cache | |
uses: Swatinem/rust-cache@v2 | |
with: | |
shared-key: shared | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v4 | |
- name: Clean docs output | |
run: cargo clean --doc | |
- name: Build docs | |
run: cargo doc --no-deps | |
- name: Add redirect | |
run: echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0;url=dicey/index.html"></head><body><p>Redirecting to <a href="./dicey/index.html">./dicey/index.html</a>...</p></body></html>' > target/doc/index.html | |
- name: Remove lock file | |
run: rm target/doc/.lock | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: target/doc | |
deploy-docs: | |
name: Deploy docs | |
needs: build-docs | |
runs-on: ubuntu-latest | |
environment: | |
name: GitHub Pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |