diff --git a/.github/workflows/rust.yaml b/.github/workflows/rust.yaml index 9c66bd3..a80c8cc 100644 --- a/.github/workflows/rust.yaml +++ b/.github/workflows/rust.yaml @@ -51,3 +51,15 @@ jobs: run: >- cargo --locked clippy --workspace --no-default-features --features "${{ matrix.backend }}" -- -D warnings + + doc_build: + runs-on: ubuntu-latest + env: + RUSTDOCFLAGS: -D warnings + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@master + with: + toolchain: stable + - name: Check documentation build + run: cargo --locked doc --workspace diff --git a/firmware-controller/Cargo.toml b/firmware-controller/Cargo.toml index 6cc8768..844e566 100644 --- a/firmware-controller/Cargo.toml +++ b/firmware-controller/Cargo.toml @@ -9,7 +9,7 @@ authors = [ ] license = "MIT" repository = "https://github.com/layerx-world/firmware-controller/" -readme = "../README.md" +readme = "README.md" [features] default = ["embassy"] diff --git a/firmware-controller/README.md b/firmware-controller/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/firmware-controller/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/firmware-controller/src/lib.rs b/firmware-controller/src/lib.rs index 0ba767f..31b3af3 100644 --- a/firmware-controller/src/lib.rs +++ b/firmware-controller/src/lib.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #[cfg(not(any(feature = "embassy", feature = "tokio")))] compile_error!("Either the `embassy` or `tokio` feature must be enabled");