From c58446f9c18bea68d8dce52ad7dcf3cf9dcf029b Mon Sep 17 00:00:00 2001 From: Riccardo Casatta Date: Mon, 3 May 2021 11:43:48 +0200 Subject: [PATCH] Deny broken doc intra-links and build docs in CI --- .github/workflows/rust.yml | 17 ++++++++++++++++- src/lib.rs | 1 + 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index a82e8e7b..c2ac4fa6 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -38,4 +38,19 @@ jobs: override: true - name: Running test script env: ${{ matrix.env }} - run: ./contrib/test.sh \ No newline at end of file + run: ./contrib/test.sh + + Docs: + name: Docs + runs-on: ubuntu-latest + steps: + - name: Checkout Crate + uses: actions/checkout@v2 + - name: Checkout Toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + - name: Create Doc + run: cargo doc diff --git a/src/lib.rs b/src/lib.rs index 80899221..1ceb42e6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -36,6 +36,7 @@ #![deny(unused_imports)] #![deny(missing_docs)] #![deny(unused_must_use)] +#![deny(broken_intra_doc_links)] // Re-exported dependencies. #[macro_use] pub extern crate bitcoin_hashes as hashes;