Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build dev docs like docs.rs #12223

Merged
merged 2 commits into from Mar 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/workflows/docs.yml
Expand Up @@ -10,6 +10,7 @@ on:
env:
CARGO_TERM_COLOR: always
RUSTDOCFLAGS: --html-in-header header.html
NIGHTLY_TOOLCHAIN: nightly

# Sets the permissions to allow deploying to Github pages.
permissions:
Expand All @@ -32,8 +33,9 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.NIGHTLY_TOOLCHAIN }}

- name: Install alsa and udev
run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev libwayland-dev libxkbcommon-dev
Expand All @@ -47,7 +49,7 @@ jobs:
echo "<meta name=\"robots\" content=\"noindex\">" > header.html

- name: Build docs
run: cargo doc --all-features --no-deps -p bevy
run: cargo doc --all-features --no-deps -p bevy -Zunstable-options -Zrustdoc-scrape-examples

# This adds the following:
# - A top level redirect to the bevy crate documentation
Expand Down