From bf5406858ffecb673d8c101aa7bf98b98c0d20ff Mon Sep 17 00:00:00 2001
From: Jan Ferdinand Sauer <ferdinand@neptune.cash>
Date: Mon, 5 Feb 2024 14:16:32 +0100
Subject: [PATCH] ci: check documentation builds free of warnings

---
 .github/workflows/main.yml                  | 5 +++++
 constraint-evaluation-generator/src/main.rs | 2 +-
 triton-tui/src/main.rs                      | 4 ++++
 3 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 23d51fca..0a3ccde7 100644
--- a/.github/workflows/main.yml
+++ b/.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
 
diff --git a/constraint-evaluation-generator/src/main.rs b/constraint-evaluation-generator/src/main.rs
index dfe33d5a..b45fab3c 100644
--- a/constraint-evaluation-generator/src/main.rs
+++ b/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>> {
diff --git a/triton-tui/src/main.rs b/triton-tui/src/main.rs
index e0e3a9d9..fe619fb3 100644
--- a/triton-tui/src/main.rs
+++ b/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;