Skip to content

Commit 5e2d5e3

Browse files
committed
docs CI - add docs --enable-index-page
1 parent 48af0ee commit 5e2d5e3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ jobs:
2020
profile: minimal
2121
components: rust-docs
2222
- name: Build docs
23-
run: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --workspace
24-
- name: Prepare /docs & index file
23+
# Building locally:
24+
# for `--enable-index-page` it is required to pass `-Z unstable-options` to rustdocs
25+
run: RUSTDOCFLAGS="--cfg docsrs -Z unstable-options --enable-index-page" cargo +nightly doc --all-features --no-deps --workspace
26+
- name: Prepare /docs
2527
run: |
2628
rm -rf ./docs
27-
echo "<meta http-equiv=\"refresh\" content=\"0; url=sentry\">" > target/doc/index.html
28-
cp -r target/doc ./docs
29+
mv target/doc ./docs
2930
- name: Deploy gh-pages
3031
# if: github.ref == 'refs/heads/aip-61-adex-v5'
3132
uses: peaceiris/actions-gh-pages@v3

0 commit comments

Comments
 (0)