Skip to content

Commit 006b740

Browse files
authored
ci: Check all crate documentation in addition to target-specific ndk (#129)
* ci: Check all crate documentation in addition to target-specific ndk Only `ndk` docs are built for all `android` targets but the rest of the documentation remains untested. Especially now that we're expanding to provide more complete docs for ndk-build and cargo-apk should everything be tested, to make sure that things like intra-doc links remain in working order. * ci: Don't build target-agnostic ndk docs for all targets The previous commit tests all documentation for all features and crates (not just `ndk`). The NDK crate and its documentation build without issues thanks to the guards introduced by the `"test"` feature. Since the `ndk` docs do not depend on any target-specific flags (and `ndk-sys` does not contain any documentation) is is fine to build-test it just once for the host architecture.
1 parent e5f0c7e commit 006b740

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

.github/workflows/rust.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ jobs:
7373
run:
7474
cargo test -p cargo-apk --all-features
7575

76+
- if: runner.os != 'Windows'
77+
name: Document all crates
78+
env:
79+
RUSTDOCFLAGS: -Dwarnings
80+
run:
81+
cargo doc --all --all-features
82+
7683
- name: Install cargo-apk
7784
run:
7885
cargo install --path cargo-apk
@@ -82,9 +89,3 @@ jobs:
8289

8390
- name: Cargo apk build for target ${{ matrix.rust-target }}
8491
run: cargo apk build -p ndk-examples --target ${{ matrix.rust-target }} --examples
85-
86-
- name: Check NDK docs for ${{ matrix.rust-target }}
87-
env:
88-
RUSTDOCFLAGS: -Dwarnings
89-
run:
90-
cargo doc -p ndk --target ${{ matrix.rust-target }} --all-features

0 commit comments

Comments
 (0)