diff --git a/.github/workflows/docs-ghpages.yml b/.github/workflows/docs-ghpages.yml new file mode 100644 index 0000000000..25d964c9c7 --- /dev/null +++ b/.github/workflows/docs-ghpages.yml @@ -0,0 +1,41 @@ +name: halo2 docs ghpages +# 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 --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: | + rm -rf ./docs + cp -R ./target/doc ./docs + echo "" > ./docs/index.html + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs +