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/.gitignore b/.gitignore index db8a9cf312..d9fabdac3d 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,5 @@ **/.*.swp **/*.rs.bk .vscode -**/*.html .DS_Store +/book/book 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 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/book.toml b/book/book.toml index 08faac511f..a865632d3e 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" @@ -14,8 +14,6 @@ title = "The halo2 Book" macros = "macros.txt" renderers = ["html"] -[output.katex] - [output.html] [output.html.print] 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" 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"