Merge #150: Build docs using nightly toolchain

2010e6b Build docs using nightly toolchain (Tobin C. Harding)

Pull request description:

  In order to get access to the `--cfg docsrs` we need to use the nightly
  toolchain. Doing so means the CI docs build mirrors the docsrs docs
  build so better tests our docs build prior to release.

ACKs for top commit:
  apoelstra:
    ACK 2010e6b

Tree-SHA512: c52a46edd73d968b18960881d1b92bdfa0ffc0e4d0269c567f04b99aa4fde2af56358b154e521eb28a242a382b138e9d2cd076e24fbac1c39c57f6e655b63035

Author: apoelstra

.github/workflows/rust.yml

@@ -3,8 +3,8 @@ on: [push, pull_request]
 name: Continuous integration
 
 jobs:
-  bench_nightly:
-    name: Nightly - ASan + Bench
+  Nightly:
+    name: Nightly - ASan + Bench + Docs
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -28,9 +28,13 @@ jobs:
         env:
           DO_BENCH: true
         run: ./contrib/test.sh
+      - name: Building docs
+        env:
+          DO_DOCS: true
+        run: ./contrib/test.sh
 
-  wasm: 
-    name: Stable - Docs / WebAssembly Build
+  wasm:
+    name: Stable - WebAssembly Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -45,10 +49,6 @@ jobs:
           profile: minimal
           toolchain: ${{ matrix.rust }}
           override: true
-      - name: Building docs
-        env:
-          DO_DOCS: true
-        run: ./contrib/test.sh
       - name: Running WASM build
         env:
           DO_WASM: true

contrib/test.sh

@@ -51,9 +51,9 @@ if [ "$DO_SCHEMARS_TESTS" = true ]; then
     (cd extended_tests/schemars && cargo test)
 fi
 
-# Docs
+# Build the docs if told to (this only works with the nightly toolchain)
 if [ "$DO_DOCS" = true ]; then
-    cargo doc --all --features="$FEATURES"
+    RUSTDOCFLAGS="--cfg docsrs" cargo doc --all --features="$FEATURES"
 fi
 
 # Webassembly stuff