From 9224f119179d04151f3335c8bf0a1d4bb04427db Mon Sep 17 00:00:00 2001 From: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com> Date: Sat, 14 Dec 2024 18:00:40 -0500 Subject: [PATCH] chore: fix index page --- .github/workflows/docs.yml | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c7f927285b..649032eb73 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,4 +1,4 @@ -name: Build and Deploy Crate Docs to Vercel +name: Build and Deploy Crate Docs to Vercel on: push: @@ -8,6 +8,9 @@ on: pull_request: branches: [main] +env: + CARGO_NET_GIT_FETCH_WITH_CLI: true + jobs: docs: permissions: @@ -31,11 +34,14 @@ jobs: ${{ secrets.GH_ACTIONS_DEPLOY_PRIVATE_KEY }} - name: Build documentation - run: cargo doc --workspace + run: cargo doc --workspace + env: + RUSTDOCFLAGS: --html-in-header assets/head.html + + - name: Build index page + run: cargo doc --workspace --no-deps --exclude "openvm-benchmarks" env: - CARGO_NET_GIT_FETCH_WITH_CLI: true - # taken from https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml - RUSTDOCFLAGS: --cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page -Zunstable-options --html-in-header assets/head.html + RUSTDOCFLAGS: --enable-index-page -Zunstable-options --html-in-header assets/head.html # TODO: make a special tag for doc commit when pushing v*.*.* tags @@ -51,4 +57,4 @@ jobs: cd target/doc mkdir .vercel echo "{\"projectId\":\"$VERCEL_PROJECT_ID\",\"orgId\":\"$VERCEL_ORG_ID\"}" > .vercel/project.json - vercel --prod --token $VERCEL_TOKEN \ No newline at end of file + vercel --prod --token $VERCEL_TOKEN