From c10e89ab357f9cd5a2815d85a48f1e5e8b97c5a0 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 4 Dec 2020 16:13:04 +0000 Subject: [PATCH 1/4] Initialise empty mdBook --- book/.gitignore | 1 + book/book.toml | 6 ++++++ book/src/SUMMARY.md | 3 +++ book/src/chapter_1.md | 1 + 4 files changed, 11 insertions(+) create mode 100644 book/.gitignore create mode 100644 book/book.toml create mode 100644 book/src/SUMMARY.md create mode 100644 book/src/chapter_1.md diff --git a/book/.gitignore b/book/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/book/.gitignore @@ -0,0 +1 @@ +book diff --git a/book/book.toml b/book/book.toml new file mode 100644 index 0000000..eb4a8d9 --- /dev/null +++ b/book/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Jack Grigg"] +language = "en" +multilingual = false +src = "src" +title = "The halo2 Book" diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md new file mode 100644 index 0000000..7390c82 --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Chapter 1](./chapter_1.md) diff --git a/book/src/chapter_1.md b/book/src/chapter_1.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/book/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1 From cb54205600d5c87c671055908b1a7dab4a298bb9 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 4 Dec 2020 16:14:54 +0000 Subject: [PATCH 2/4] Actions workflow to deploy book to GH Pages --- .github/workflows/book.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/book.yml diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 0000000..404e473 --- /dev/null +++ b/.github/workflows/book.yml @@ -0,0 +1,26 @@ +name: halo2 book + +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@v2 + + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + with: + mdbook-version: '0.4.4' + + - name: Build halo2 book + run: mdbook build book/ + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book/book From e21c72a5a6f4f01ad70fc901488b6e96e4b144bb Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 4 Dec 2020 16:15:06 +0000 Subject: [PATCH 3/4] CI: Run book tests --- .github/workflows/ci.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c909a82..dbe0126 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -64,6 +64,18 @@ jobs: command: build args: --all --benches --all-features + book: + name: Book tests + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + with: + mdbook-version: '0.4.4' + - name: Test halo2 book + run: mdbook test book/ + clippy: name: Clippy (stable) timeout-minutes: 30 From 0bc95f27768f5242d3f844dd4832db69870d819f Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 4 Dec 2020 17:19:17 +0000 Subject: [PATCH 4/4] Add initial book skeleton --- book/src/README.md | 1 + book/src/SUMMARY.md | 8 ++++++-- book/src/chapter_1.md | 1 - book/src/concepts.md | 1 + book/src/design.md | 1 + book/src/user.md | 1 + book/src/user/gadgets.md | 1 + 7 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 book/src/README.md delete mode 100644 book/src/chapter_1.md create mode 100644 book/src/concepts.md create mode 100644 book/src/design.md create mode 100644 book/src/user.md create mode 100644 book/src/user/gadgets.md diff --git a/book/src/README.md b/book/src/README.md new file mode 100644 index 0000000..676d71c --- /dev/null +++ b/book/src/README.md @@ -0,0 +1 @@ +{{#include ../../README.md}} diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 7390c82..e743c38 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -1,3 +1,7 @@ -# Summary +# The halo2 Book -- [Chapter 1](./chapter_1.md) +[halo2](README.md) +- [Concepts](concepts.md) +- [User Documentation](user.md) + - [Gadgets](user/gadgets.md) +- [Design](design.md) diff --git a/book/src/chapter_1.md b/book/src/chapter_1.md deleted file mode 100644 index b743fda..0000000 --- a/book/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/book/src/concepts.md b/book/src/concepts.md new file mode 100644 index 0000000..74d42e1 --- /dev/null +++ b/book/src/concepts.md @@ -0,0 +1 @@ +# Concepts diff --git a/book/src/design.md b/book/src/design.md new file mode 100644 index 0000000..3d14cb7 --- /dev/null +++ b/book/src/design.md @@ -0,0 +1 @@ +# Design diff --git a/book/src/user.md b/book/src/user.md new file mode 100644 index 0000000..3a51d9a --- /dev/null +++ b/book/src/user.md @@ -0,0 +1 @@ +# User Documentation diff --git a/book/src/user/gadgets.md b/book/src/user/gadgets.md new file mode 100644 index 0000000..406e8aa --- /dev/null +++ b/book/src/user/gadgets.md @@ -0,0 +1 @@ +# Gadgets