From 455f91501d16322f68a5d359f17010343e209a0e Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Mon, 17 Aug 2020 12:35:27 -0700 Subject: [PATCH] doc: exclude zebra-utils, zebra-checkpoint. These are internal-only crates for development. --- .github/workflows/firebase.yml | 3 ++- zebra-utils/src/lib.rs | 17 +++-------------- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/.github/workflows/firebase.yml b/.github/workflows/firebase.yml index 3dbca6f8..0c01cd55 100644 --- a/.github/workflows/firebase.yml +++ b/.github/workflows/firebase.yml @@ -42,7 +42,8 @@ jobs: - name: Build external docs run: | - cargo doc --no-deps + # Exclude zebra-utils, it is not for library or app users + cargo doc --no-deps --workspace --exclude zebra-utils env: RUSTDOCFLAGS: "--html-in-header katex-header.html" diff --git a/zebra-utils/src/lib.rs b/zebra-utils/src/lib.rs index c126771c..b1a9b35c 100644 --- a/zebra-utils/src/lib.rs +++ b/zebra-utils/src/lib.rs @@ -1,14 +1,3 @@ -//! A Zebra utilities crate. - -// TODO: split this crate up into crates with meaningful names. - -#![deny(missing_docs)] -#![allow(clippy::try_err)] - -#[cfg(test)] -mod tests { - #[test] - fn it_works() { - assert_eq!(2 + 2, 4); - } -} +//! Utilities for Zebra development, not for library or application users. +//! +//! Currently this consists only of the zebra-checkpoints binary.