Skip to content

Commit

Permalink
chore: fix index page
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanpwang committed Dec 14, 2024
1 parent db4d38a commit 9224f11
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build and Deploy Crate Docs to Vercel
name: Build and Deploy Crate Docs to Vercel

on:
push:
Expand All @@ -8,6 +8,9 @@ on:
pull_request:
branches: [main]

env:
CARGO_NET_GIT_FETCH_WITH_CLI: true

jobs:
docs:
permissions:
Expand All @@ -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

Expand All @@ -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
vercel --prod --token $VERCEL_TOKEN

0 comments on commit 9224f11

Please sign in to comment.