fix: Turn cargo doc warnings into errors (#4710)

* fix: Correct intra-doc links

* fix: Turn cargo doc warnings into errors

Co-authored-by: Jake Goulding <jake.goulding@integer32.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

.circleci/config.yml

@@ -140,6 +140,8 @@ jobs:
       RUSTFLAGS: "-C debuginfo=1"
       # https://github.com/rust-lang/cargo/issues/10280
       CARGO_NET_GIT_FETCH_WITH_CLI: "true"
+      # Turn warnings into errors
+      RUSTDOCFLAGS: "-D warnings -A rustdoc::private-intra-doc-links"
     steps:
       - checkout
       - rust_components

ioxd_querier/src/rpc/namespace.rs

@@ -5,7 +5,7 @@ use generated_types::influxdata::iox::namespace::v1 as proto;
 use querier::QuerierDatabase;
 use std::sync::Arc;
 
-/// Acquire a [`NamespaceService`] gRPC service implementation.
+/// Acquire a [`NamespaceService`](proto::namespace_service_server::NamespaceService) gRPC service implementation.
 pub fn namespace_service(
     server: Arc<QuerierDatabase>,
 ) -> proto::namespace_service_server::NamespaceServiceServer<

query_functions/src/selectors.rs

@@ -173,7 +173,7 @@ trait Selector: Debug + Default + Send + Sync {
 }
 
 /// Describes which part of the selector to return: the timestamp or
-/// the value (when https://issues.apache.org/jira/browse/ARROW-10945
+/// the value (when <https://issues.apache.org/jira/browse/ARROW-10945>
 /// is fixed, this enum should be removed)
 #[derive(Debug, Clone, Copy)]
 pub enum SelectorOutput {

service_grpc_influxrpc/src/service.rs

@@ -1,5 +1,5 @@
 //! This module contains implementations for the storage gRPC service
-//! implemented in terms of the [`QueryDatabase`](query::QueryDatabase).
+//! implemented in terms of the [`QueryDatabase`](iox_query::QueryDatabase).
 
 use super::{TAG_KEY_FIELD, TAG_KEY_MEASUREMENT};
 use crate::{

test_helpers_end_to_end/src/config.rs

@@ -33,8 +33,8 @@ pub struct TestConfig {
 }
 
 impl TestConfig {
-    /// Create a new TestConfig (tests should use one of the specific
-    /// configuration setup below, such as [new_router]
+    /// Create a new TestConfig. Tests should use one of the specific
+    /// configuration setup below, such as [new_router](Self::new_router).
     fn new(
         server_type: ServerType,
         dsn: impl Into<String>,

test_helpers_end_to_end/src/mini_cluster.rs

@@ -54,7 +54,7 @@ impl MiniCluster {
     /// servers but has a new unique namespace and set of connections
     ///
     /// Note this is an internal implementation -- please use
-    /// [create_shared], and [new] to create new MiniClusters.
+    /// [`create_shared`](Self::create_shared), and [`new`](Self::new) to create new MiniClusters.
     fn new_from_fixtures(
         router: Option<ServerFixture>,
         ingester: Option<ServerFixture>,