From 3eb4ec5c1921b231d63568987ac175a0392e41e3 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Tue, 21 Nov 2023 23:33:06 +0000 Subject: [PATCH 1/5] Change Daira Emma's name in `authors` fields. Signed-off-by: Daira Emma Hopwood --- book/book.toml | 2 +- halo2_gadgets/Cargo.toml | 2 +- halo2_proofs/Cargo.toml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/book/book.toml b/book/book.toml index 08faac511f..eef625c662 100644 --- a/book/book.toml +++ b/book/book.toml @@ -2,7 +2,7 @@ authors = [ "Jack Grigg", "Sean Bowe", - "Daira Hopwood", + "Daira Emma Hopwood", "Ying Tong Lai", ] language = "en" diff --git a/halo2_gadgets/Cargo.toml b/halo2_gadgets/Cargo.toml index 09ab4efc84..8af41bef2f 100644 --- a/halo2_gadgets/Cargo.toml +++ b/halo2_gadgets/Cargo.toml @@ -4,7 +4,7 @@ version = "0.3.0" authors = [ "Sean Bowe ", "Jack Grigg ", - "Daira Hopwood ", + "Daira Emma Hopwood ", "Ying Tong Lai ", "Kris Nuttycombe ", ] diff --git a/halo2_proofs/Cargo.toml b/halo2_proofs/Cargo.toml index 11b8364b14..4853999ce9 100644 --- a/halo2_proofs/Cargo.toml +++ b/halo2_proofs/Cargo.toml @@ -4,7 +4,7 @@ version = "0.3.0" authors = [ "Sean Bowe ", "Ying Tong Lai ", - "Daira Hopwood ", + "Daira Emma Hopwood ", "Jack Grigg ", ] edition = "2021" From de1d2370139db049e09dcad18b138d41d8eb5315 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Tue, 21 Nov 2023 23:36:46 +0000 Subject: [PATCH 2/5] Revert "Add book/Makefile for local HTML generation." This reverts commit 591ab49266f87c70c77d04f6041af2b7245c7b34. Signed-off-by: Daira Emma Hopwood --- .gitignore | 1 - book/Makefile | 10 ---------- book/edithtml.sh | 28 ---------------------------- 3 files changed, 39 deletions(-) delete mode 100644 book/Makefile delete mode 100755 book/edithtml.sh diff --git a/.gitignore b/.gitignore index db8a9cf312..08b4233c4a 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,4 @@ **/.*.swp **/*.rs.bk .vscode -**/*.html .DS_Store diff --git a/book/Makefile b/book/Makefile deleted file mode 100644 index 2fb3f9a9cd..0000000000 --- a/book/Makefile +++ /dev/null @@ -1,10 +0,0 @@ -.PHONY: all -all: - find src -type f -a -name '*.md' |sed 's/[.]md$$/.html/g' |xargs $(MAKE) - -clean: - find src -type f -a -name '*.html' -print0 |xargs -0 rm - -%.html: %.md - pandoc --katex --from=markdown --to=html "$<" "--output=$@" - ./edithtml.sh "$@" "$<" diff --git a/book/edithtml.sh b/book/edithtml.sh deleted file mode 100755 index 4825478716..0000000000 --- a/book/edithtml.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/sh - -cat - "$1" > "$1.prefix" < - - - - - - $2 - - - - - - -EOF -cat "$1.prefix" - >"$1" < - -EOF -rm -f "$1.prefix" From 2e617ae1dacb62719d877996363594cc87923fa8 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Tue, 21 Nov 2023 23:38:18 +0000 Subject: [PATCH 3/5] Add `/book/book` to `.gitignore`. Signed-off-by: Daira Emma Hopwood --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 08b4233c4a..d9fabdac3d 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ **/*.rs.bk .vscode .DS_Store +/book/book From 4a8e640afd97af7cb783c536fdea5ef0e73206e0 Mon Sep 17 00:00:00 2001 From: Daira-Emma Hopwood Date: Tue, 6 Feb 2024 12:54:21 +0000 Subject: [PATCH 4/5] Remove references to the empty `halo2` crate from the README, and link to the `halo2_proofs` and `halo2_gadgets` READMEs. Signed-off-by: Daira-Emma Hopwood --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9ade4d432a..3c78e8633c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# halo2 [![Crates.io](https://img.shields.io/crates/v/halo2.svg)](https://crates.io/crates/halo2) # +# halo2 -## [Documentation](https://docs.rs/halo2) +## Usage + +This repository contains the [halo2_proofs](halo2_proofs/README.md) and +[halo2_gadgets](halo2_gadgets/README.md) crates, which should be used directly. ## Minimum Supported Rust Version From daaa6389662cc61006d3a6948065fd032feb4355 Mon Sep 17 00:00:00 2001 From: adria0 Date: Thu, 22 Feb 2024 22:28:36 +0100 Subject: [PATCH 5/5] fix(mdbook): fix generation --- .github/workflows/book.yml | 9 +++++++-- book/book.toml | 2 -- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index 3e6e5e3deb..35759a06bf 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -12,7 +12,7 @@ jobs: - uses: actions/checkout@v3 - uses: actions-rs/toolchain@v1 with: - toolchain: nightly + toolchain: '1.76.0' override: true # - name: Setup mdBook @@ -26,7 +26,7 @@ jobs: uses: actions-rs/cargo@v1 with: command: install - args: mdbook --git https://github.com/HollowMan6/mdBook.git --rev 62e01b34c23b957579c04ee1b24b57814ed8a4d5 + args: mdbook --git https://github.com/HollowMan6/mdBook.git --rev 5830c9555a4dc051675d17f1fcb04dd0920543e8 - name: Install mdbook-katex and mdbook-pdf uses: actions-rs/cargo@v1 @@ -40,6 +40,11 @@ jobs: - name: Build halo2 book run: mdbook build book/ + - uses: actions-rs/toolchain@v1 + with: + toolchain: nightly-2023-10-05 + override: true + - name: Build latest rustdocs uses: actions-rs/cargo@v1 with: diff --git a/book/book.toml b/book/book.toml index eef625c662..a865632d3e 100644 --- a/book/book.toml +++ b/book/book.toml @@ -14,8 +14,6 @@ title = "The halo2 Book" macros = "macros.txt" renderers = ["html"] -[output.katex] - [output.html] [output.html.print]