Write docs for calyx-pass-explorer
(#2341)
#917
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
## Uses the deployment flow described here: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-deploy-to-external-repository-external_repository | |
# The cucapra/calyx-docs repository contains the public deployment key and the main Calyx repository contains the private key enabling it to write to the docs repository. | |
name: Docs website | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
playground: | |
name: Docs website | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Setup mdBook | |
uses: peaceiris/actions-mdbook@v1 | |
with: | |
mdbook-version: "latest" | |
- name: Install callouts preprocessor | |
run: cargo install --git https://github.com/ToolmanP/rs-mdbook-callouts --rev 83898e352a961fc65044e04c864141c8b5481722 | |
- name: mdbook | |
run: mdbook build | |
- name: Install Rust stable | |
uses: actions-rs/toolchain@v1 | |
with: | |
toolchain: 1.66.0 | |
override: true | |
components: rustfmt, clippy | |
- name: Build source documentation | |
uses: actions-rs/cargo@v1 | |
with: | |
command: doc | |
args: -p calyx-ir -p calyx-utils -p calyx-frontend -p calyx-opt --no-deps | |
- name: Move source documentation | |
run: | | |
mv ./target/doc ./book/source | |
- name: Create CNAME files | |
run: | | |
echo 'docs.calyxir.org' > ./book/CNAME | |
- name: deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
publish_branch: main | |
deploy_key: ${{ secrets.DOCS_DEPLOY_TOKEN }} | |
external_repository: cucapra/calyx-docs | |
publish_dir: ./book |