feat: barretenberg doxygen CI

.circleci/config.yml

@@ -192,6 +192,21 @@ jobs:
           name: "Build"
           command: cond_spot_run_build barretenberg-x86_64-linux-clang-sol 32
 
+  barretenberg-docs:
+    machine:
+      image: ubuntu-2204:2023.07.2
+    resource_class: large
+    steps:
+      - *checkout
+      - *setup_env
+      - run:
+          name: "Build barretenberg docs"
+          command: build barretenberg-docs
+      - run:
+          name: "Deploy barretenberg docs"
+          command: |
+            barretenberg/cpp/docs/deploy_doxygen.sh
+
   barretenberg-stdlib-tests:
     docker:
       - image: aztecprotocol/alpine-build-image
@@ -1091,6 +1106,7 @@ workflows:
             - barretenberg-x86_64-linux-clang-assert
             - noir-compile-acir-tests
           <<: *defaults
+      - barretenberg-docs: *defaults
       - bb-js:
           requires:
             - barretenberg-wasm-linux-clang

barretenberg/cpp/.dockerignore

@@ -20,4 +20,7 @@
 !scripts/install-wasi-sdk.sh
 !scripts/strip-wasm.sh
 !./.clang-format
-!./format.sh
+!./format.sh
+
+# Doxygen stuff.
+!docs

barretenberg/cpp/docs/Dockerfile

@@ -0,0 +1,15 @@
+FROM alpine:3.18 AS builder
+RUN apk update \
+    && apk upgrade \
+    && apk add --no-cache \
+        build-base \
+        clang16 \
+        cmake \
+        ninja \
+        git \
+        curl \
+        perl \
+        doxygen
+WORKDIR /usr/src/barretenberg/cpp/
+COPY . .
+RUN doxygen docs/Doxyfile

barretenberg/cpp/docs/Doxyfile

@@ -0,0 +1,19 @@
+# Minimal Doxyfile. See https://www.doxygen.nl/manual/config.html
+
+# Project related configuration options
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "barretenberg"
+
+# Paths and filenames
+INPUT                  = src/barretenberg
+HTML_OUTPUT            = docs/build
+FILE_PATTERNS          = *.c \
+                         *.cpp \
+                         *.h \
+                         *.hpp
+RECURSIVE              = YES
+
+# Output format options
+GENERATE_HTML          = YES
+GENERATE_LATEX         = NO
+HAVE_DOT               = NO

barretenberg/cpp/docs/deploy_doxygen.sh

@@ -0,0 +1,14 @@
+# Uploads to S3 the contents of a doxygen barretenberg C++ documentation build.
+# This is then to be used as a static website.
+#!/usr/bin/env bash
+[ -n "${BUILD_SYSTEM_DEBUG:-}" ] && set -x # conditionally trace
+set -eu
+
+extract_repo barretenberg-docs /usr/src extracted-repo
+
+BUCKET_NAME="aztec-ci-artifacts"
+COMMIT_HASH="${COMMIT_HASH:-$(git rev-parse HEAD)}"
+TARGET_FOLDER="barretenberg-doxygen/$COMMIT_HASH"
+
+echo "Uploading to s3://$BUCKET_NAME/$TARGET_FOLDER"
+aws s3 cp extracted-repo/src/barretenberg/cpp/docs/build "s3://$BUCKET_NAME/$TARGET_FOLDER" --recursive

build_manifest.yml

@@ -104,6 +104,10 @@ barretenberg-acir-tests-bb.js:
     - bb.js
     - noir-compile-acir-tests
 
+barretenberg-docs:
+  buildDir: barretenberg/cpp
+  dockerfile: docs/Dockerfile
+
 l1-contracts:
   buildDir: l1-contracts