2020-12-04 08:14:54 -08:00
|
|
|
name: halo2 book
|
|
|
|
|
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- main
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
deploy:
|
2022-04-24 15:53:53 -07:00
|
|
|
runs-on: ubuntu-latest
|
2020-12-04 08:14:54 -08:00
|
|
|
steps:
|
2022-04-28 17:26:50 -07:00
|
|
|
- uses: actions/checkout@v3
|
2021-07-09 12:12:40 -07:00
|
|
|
- uses: actions-rs/toolchain@v1
|
|
|
|
with:
|
2024-02-22 13:28:36 -08:00
|
|
|
toolchain: '1.76.0'
|
2021-07-09 12:12:40 -07:00
|
|
|
override: true
|
2020-12-04 08:14:54 -08:00
|
|
|
|
2023-01-08 11:34:51 -08:00
|
|
|
# - name: Setup mdBook
|
|
|
|
# uses: peaceiris/actions-mdbook@v1
|
|
|
|
# with:
|
|
|
|
# mdbook-version: 'latest'
|
|
|
|
|
|
|
|
# mdBook for mdbook-pdf compatibility by fixing broken links in print.html
|
|
|
|
# Waiting for https://github.com/rust-lang/mdBook/pull/1738 to get merged
|
|
|
|
- name: Install patched mdbook
|
2023-01-10 12:02:17 -08:00
|
|
|
uses: actions-rs/cargo@v1
|
|
|
|
with:
|
|
|
|
command: install
|
2024-02-22 13:28:36 -08:00
|
|
|
args: mdbook --git https://github.com/HollowMan6/mdBook.git --rev 5830c9555a4dc051675d17f1fcb04dd0920543e8
|
2020-12-04 08:14:54 -08:00
|
|
|
|
2023-01-08 11:34:51 -08:00
|
|
|
- name: Install mdbook-katex and mdbook-pdf
|
2020-12-10 12:09:47 -08:00
|
|
|
uses: actions-rs/cargo@v1
|
|
|
|
with:
|
|
|
|
command: install
|
2023-01-08 11:34:51 -08:00
|
|
|
args: mdbook-katex mdbook-pdf
|
|
|
|
|
|
|
|
- name: Install mdbook-pdf-outline
|
|
|
|
run: pip3 install mdbook-pdf-outline
|
2020-12-10 12:09:47 -08:00
|
|
|
|
2020-12-04 08:14:54 -08:00
|
|
|
- name: Build halo2 book
|
|
|
|
run: mdbook build book/
|
|
|
|
|
2024-02-22 13:28:36 -08:00
|
|
|
- uses: actions-rs/toolchain@v1
|
|
|
|
with:
|
|
|
|
toolchain: nightly-2023-10-05
|
|
|
|
override: true
|
|
|
|
|
2021-07-09 12:12:40 -07:00
|
|
|
- name: Build latest rustdocs
|
|
|
|
uses: actions-rs/cargo@v1
|
|
|
|
with:
|
2022-02-03 16:58:59 -08:00
|
|
|
command: doc
|
|
|
|
args: --no-deps --workspace --all-features
|
|
|
|
env:
|
2022-04-24 16:14:45 -07:00
|
|
|
RUSTDOCFLAGS: -Z unstable-options --enable-index-page --cfg docsrs --html-in-header ${{ github.workspace }}/halo2_proofs/katex-header.html
|
2021-07-09 12:12:40 -07:00
|
|
|
|
|
|
|
- name: Move latest rustdocs into book
|
|
|
|
run: |
|
2023-01-20 13:18:42 -08:00
|
|
|
mkdir -p ./book/book/html/rustdoc
|
|
|
|
mv ./target/doc ./book/book/html/rustdoc/latest
|
2021-07-09 12:12:40 -07:00
|
|
|
|
2020-12-04 08:14:54 -08:00
|
|
|
- name: Deploy to GitHub Pages
|
|
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
|
|
with:
|
|
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
2023-01-20 13:18:42 -08:00
|
|
|
publish_dir: ./book/book/html
|
2023-01-08 11:34:51 -08:00
|
|
|
|
|
|
|
- name: Upload PDF File to Artifact
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
with:
|
|
|
|
name: The_halo2_Book
|
|
|
|
path: book/book/pdf-outline/*.pdf
|