Fix rustdoc warnings, check docs in CI (#1018)

Just something that I noticed when contributing to the docs sometime in
the past

Author: Expurple

.github/workflows/rust.yml

@@ -27,8 +27,19 @@ env:
   RUSTC_WRAPPER: "sccache"
   RUSTFLAGS: "-C debuginfo=0"
   CARGO_INCREMENTAL: 0
+  RUSTDOCFLAGS: --cfg doc_cfg -D warnings
 
 jobs:
+  rustdoc:
+    Name: Rustdoc
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dtolnay/rust-toolchain@nightly
+      with:
+        components: rustdoc
+    - run: cargo +nightly doc --workspace --no-deps --all-features --document-private-items
+
   rustfmt:
     name: Rustfmt
     runs-on: ubuntu-latest

src/backend/query_builder.rs

@@ -535,7 +535,7 @@ pub trait QueryBuilder:
         }
     }
 
-    /// Translate [`IndexHint`] into SQL statement.
+    /// Translate [`IndexHint`][crate::extension::mysql::IndexHint] into SQL statement.
     fn prepare_index_hints(
         &self,
         _table_ref: &TableRef,
@@ -544,7 +544,7 @@ pub trait QueryBuilder:
     ) {
     }
 
-    /// Translate [`TableSample`] into SQL statement.
+    /// Translate [`TableSample`][crate::extension::postgres::TableSample] into SQL statement.
     fn prepare_table_sample(&self, _select: &SelectStatement, _sql: &mut impl SqlWriter) {}
 
     /// Translate [`LockType`] into SQL statement.

src/expr/trait.rs

@@ -3,7 +3,7 @@ use crate::{Expr, func::*, query::*, types::*, value::*};
 /// "Operator" methods for building expressions.
 ///
 /// Before `sea_query` 0.32.0 (`sea_orm` 1.1.1),
-/// these methods were awailable only on [`Expr`]/[`SimpleExpr`]
+/// these methods were awailable only on [`Expr`]/[`SimpleExpr`][crate::SimpleExpr]
 /// and you needed to manually construct these types first.
 ///
 /// Now, you can call them directly on any expression type:

src/query/delete.rs

@@ -259,7 +259,8 @@ impl DeleteStatement {
         clause.query(self)
     }
 
-    /// Create a Common Table Expression by specifying a [CommonTableExpression] or [WithClause] to execute this query with.
+    /// Create a Common Table Expression by specifying a [CommonTableExpression][crate::CommonTableExpression]
+    /// or [WithClause] to execute this query with.
     ///
     /// # Examples
     ///

src/query/insert.rs

@@ -454,8 +454,6 @@ impl InsertStatement {
     /// # Examples
     ///
     /// - [`OnConflict::update_columns`]: Update column value of existing row with inserting value
-    /// - [`OnConflict::update_values`]: Update column value of existing row with value
-    /// - [`OnConflict::update_exprs`]: Update column value of existing row with expression
     pub fn on_conflict(&mut self, on_conflict: OnConflict) -> &mut Self {
         self.on_conflict = Some(on_conflict);
         self
@@ -606,7 +604,8 @@ impl InsertStatement {
         clause.query(self)
     }
 
-    /// Create a Common Table Expression by specifying a [CommonTableExpression] or [WithClause] to execute this query with.
+    /// Create a Common Table Expression by specifying a [CommonTableExpression][crate::CommonTableExpression]
+    /// or [WithClause] to execute this query with.
     ///
     /// # Examples
     ///

src/query/select.rs

@@ -2469,7 +2469,8 @@ impl SelectStatement {
         clause.query(self)
     }
 
-    /// Create a Common Table Expression by specifying a [CommonTableExpression] or [WithClause] to execute this query with.
+    /// Create a Common Table Expression by specifying a [CommonTableExpression][crate::CommonTableExpression]
+    /// or [WithClause] to execute this query with.
     ///
     /// # Examples
     ///

src/query/update.rs

@@ -397,7 +397,8 @@ impl UpdateStatement {
         clause.query(self)
     }
 
-    /// Create a Common Table Expression by specifying a [CommonTableExpression] or [WithClause] to execute this query with.
+    /// Create a Common Table Expression by specifying a [CommonTableExpression][crate::CommonTableExpression]
+    /// or [WithClause] to execute this query with.
     ///
     /// # Examples
     ///

src/raw_sql/seaql.rs

@@ -19,7 +19,7 @@ impl Query {
         self
     }
 
-    /// Matches the signature of [`SqlWriterValues::into_parts`]
+    /// Matches the signature of [`SqlWriterValues::into_parts`][crate::SqlWriterValues::into_parts]
     pub fn into_parts(self) -> (String, Values) {
         (self.sql, self.values)
     }