Skip to content

Commit

Permalink
Update docs-ghpages.yml - 02 automate building rust docs and deploy t…
Browse files Browse the repository at this point in the history
…o github pages
  • Loading branch information
thogiti authored and CPerezz committed Sep 18, 2023
1 parent c66fafa commit 56325ea
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions .github/workflows/docs-ghpages.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
name: halo2 docs ghpages
# Host the docs on github pages
# Setup docs for ghpages

on:
push:
branches:
- main

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true


- name: Build latest rustdocs
uses: actions-rs/cargo@v1
with:
command: doc
args: --no-deps --workspace --all-features
args: --no-deps --all-features --workspace
env:
RUSTDOCFLAGS: -Z unstable-options --enable-index-page --cfg docsrs --html-in-header ${{ github.workspace }}/halo2_proofs/katex-header.html

- name: Create the required index page and move the latest rustdocs into docs
run: |
echo "<meta http-equiv=\"refresh\" content=\"0; url=build_wheel\">" > ./target/doc/index.html
mkdir -p ./docs
mv ./target/doc ./docs
rm -rf ./docs
cp -R ./target/doc ./docs
echo "<meta http-equiv=\"refresh\" content=\"0; url=pse_halo2\">" > ./docs/index.html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs


0 comments on commit 56325ea

Please sign in to comment.