Run doctests on CI

Author: korken89

.github/workflows/build.yml

@@ -33,7 +33,37 @@ jobs:
           command: fmt
           args: --all -- --check
 
-  # Compilation 
+  # Run cargo test
+  test:
+    name: test
+    strategy:
+      matrix:
+        target:
+          - x86_64-unknown-linux-gnu
+        toolchain:
+          - stable
+        features:
+          - stm32f745,smi
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Rust ${{ matrix.toolchain }} with target (${{ matrix.target }})
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          target: ${{ matrix.target }}
+          override: true
+
+      - name: cargo test the documentation and readme
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --target=${{ matrix.target }} --features ${{ matrix.features }}
+
+
+  # Compilation
   build:
     name: build
     runs-on: ubuntu-20.04
@@ -43,7 +73,7 @@ jobs:
           - x86_64-unknown-linux-gnu
         toolchain:
           - stable
-        features: 
+        features:
           - stm32f107,smi
           - stm32f407,smi
           - stm32f417,smi
@@ -79,7 +109,7 @@ jobs:
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --features ${{ matrix.features }} 
+          args: --target=${{ matrix.target }} --features ${{ matrix.features }}
 
   # Examples
   examples:
@@ -114,28 +144,28 @@ jobs:
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example ip --features stm32f429,smoltcp-phy,log,smoltcp/socket-tcp,smoltcp/socket-icmp,smoltcp/log,smoltcp/verbose 
-      
+          args: --target=${{ matrix.target }} --example ip --features stm32f429,smoltcp-phy,log,smoltcp/socket-tcp,smoltcp/socket-icmp,smoltcp/log,smoltcp/verbose
+
       - name: cargo build f4 example arp
         uses: actions-rs/cargo@v1
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example arp --features stm32f407,smi 
-      
+          args: --target=${{ matrix.target }} --example arp --features stm32f407,smi
+
       - name: cargo build f4 example arp-smoltcp
         uses: actions-rs/cargo@v1
         with:
           use-cross: false
           command: build
           args: --target=${{ matrix.target }} --example arp-smoltcp --features stm32f407,smi,smoltcp-phy,smoltcp/socket-icmp
-      
+
       - name: cargo build f1 example ip
         uses: actions-rs/cargo@v1
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example ip-f107 --features stm32f107,smoltcp-phy,log,smoltcp/socket-tcp,smoltcp/socket-icmp,smoltcp/log,smoltcp/verbose 
+          args: --target=${{ matrix.target }} --example ip-f107 --features stm32f107,smoltcp-phy,log,smoltcp/socket-tcp,smoltcp/socket-icmp,smoltcp/log,smoltcp/verbose
 
   # Refs: https://github.com/rust-lang/crater/blob/9ab6f9697c901c4a44025cf0a39b73ad5b37d198/.github/workflows/bors.yml#L125-L149
   #
@@ -147,6 +177,7 @@ jobs:
     needs:
       - style
       - build
+      - test
       - examples
     runs-on: ubuntu-20.04
     steps: