Merge #344

344: Fix building docs and add CI check r=eldruin a=sirhcel

Declaring `panic-halt` as a depencency works fine for building the example code but it makes `cargo doc` fail due to the duplicate lang item `panic_impl`.

This issue got already reported with #314 and gets fixed by this PR by simply removing the unused `panic-halt` handler.

Co-authored-by: Christian Meusel <christian.meusel@posteo.de>

Author: bors[bot]

.github/workflows/ci.yml

@@ -32,6 +32,19 @@ jobs:
         working-directory: src/${{ matrix.chapter }}
         run: cargo build
 
+  # Check a build succeeds for docs.
+  build-doc:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          target: thumbv7em-none-eabihf
+      - name: Build docs
+        run: cargo doc
+
   # Build the book HTML itself and optionally publish it.
   build-book:
     runs-on: ubuntu-20.04

src/05-led-roulette/auxiliary/Cargo.toml

@@ -12,5 +12,4 @@ version = "0.2.0"
 cortex-m = "0.6.4"
 cortex-m-rt = "0.6.13"
 stm32f3-discovery = "0.6.0"
-panic-halt = "0.2.0"
 panic-itm = "0.4.2"

src/05-led-roulette/build-it.md

@@ -57,7 +57,6 @@ $ cargo build --target thumbv7em-none-eabihf
    Compiling cfg-if v1.0.0
    Compiling paste v1.0.4
    Compiling stm32f3-discovery v0.6.0
-   Compiling panic-halt v0.2.0
    Compiling embedded-dma v0.1.2
    Compiling volatile-register v0.2.0
    Compiling nb v0.1.3

src/06-hello-world/auxiliary/Cargo.toml

@@ -11,5 +11,4 @@ version = "0.2.0"
 cortex-m = "0.6.4"
 cortex-m-rt = "0.6.13"
 stm32f3-discovery = "0.5.0"
-panic-halt = "0.2.0"
 panic-itm = "0.4.2"

src/07-registers/auxiliary/Cargo.toml

@@ -11,7 +11,6 @@ version = "0.2.0"
 cortex-m = "0.6.4"
 cortex-m-rt = "0.6.13"
 stm32f3-discovery = "0.6.0"
-panic-halt = "0.2.0"
 panic-itm = "0.4.2"
 
 [dependencies.stm32f3]