ci: check documentation builds free of warnings

.github/workflows/main.yml

@@ -31,6 +31,11 @@ jobs:
       - name: Run fmt
         run: cargo fmt --all -- --check
 
+      - name: Build documentation
+        run: cargo doc --no-deps --workspace
+        env:
+          RUSTDOCFLAGS: -D warnings
+
       - name: Run clippy
         run: cargo clippy --all-targets -- -D warnings
 

constraint-evaluation-generator/src/main.rs

@@ -419,7 +419,7 @@ fn generate_constraint_code(constraints: Constraints) -> TokenStream {
     )
 }
 
-/// Consumes every `ConstraintCircuitMonad`, returning their corresponding `ConstraintCircuit`s.
+/// Consumes every [`ConstraintCircuitMonad`], returning their corresponding [`ConstraintCircuit`]s.
 fn consume<II: InputIndicator>(
     constraints: Vec<ConstraintCircuitMonad<II>>,
 ) -> Vec<ConstraintCircuit<II>> {

triton-tui/src/main.rs

@@ -1,3 +1,7 @@
+//! Triton TUI is a terminal user interface for Triton VM. It allows executing and debugging
+//! programs in Triton assembly. It is intended to be used as a standalone application;
+//! see the [README](https://crates.io/crates/triton-tui) for more information.
+
 use clap::Parser;
 use color_eyre::eyre::Result;
 use tracing::error;