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 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 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/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 new file mode 100644 index 0000000..e743c38 --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,7 @@ +# The halo2 Book + +[halo2](README.md) +- [Concepts](concepts.md) +- [User Documentation](user.md) + - [Gadgets](user/gadgets.md) +- [Design](design.md) 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