Commit Graph

15 Commits

Author SHA1 Message Date
adria0 daaa638966 fix(mdbook): fix generation 2024-02-22 22:28:36 +01:00
Jack Grigg 5e51272551 CI: Publish correct book path
zcash/halo2#713 added a second renderer to mdBook, and it turns out
that causes mdBook to generate subfolders that it doesn't do with a
single renderer. We now handle the presence of the subfolders when
publishing the book to GitHub Pages.
2023-01-20 21:18:42 +00:00
Hollow Man 398f80bb03
Use revision of the patched mdbook
Signed-off-by: Hollow Man <hollowman@opensuse.org>
2023-01-10 22:02:17 +02:00
Hollow Man 79c5517d21
Fix book deploying CI and add pdf uploading
Signed-off-by: Hollow Man <hollowman@opensuse.org>
2023-01-08 21:34:51 +02:00
dependabot[bot] 1d9ca93948
Bump actions/checkout from 2 to 3
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-29 00:26:50 +00:00
Jack Grigg 2cf0125c78 CI: Pass the correct `katex-header.html` path to rustdoc
The header was moved to fix docs.rs deployment, but the CI workflow
wasn't updated to account for this.
2022-04-24 23:14:45 +00:00
Jack Grigg b866548c5f Revert "CI: Pin nightly version in book workflow"
This reverts commit 53427d19db.

Closes zcash/halo2#503.
2022-04-24 22:59:39 +00:00
Jack Grigg d43c8612a3 CI: Use `ubuntu-latest` runner for book workflow
The `mdbook` binaries are currently built using `ubuntu-latest`, meaning
can end up relying on newer versions of GLIBC. Until this is fixed
upstream (https://github.com/rust-lang/mdBook/issues/1779), we will use
the same runner configuration as them.
2022-04-24 22:57:02 +00:00
Jack Grigg 53427d19db CI: Pin nightly version in book workflow
We require nightly Rust to build the documentation, but latest nightly
has a bug where `--no-deps` causes an ICE.
2022-02-04 01:23:32 +00:00
Jack Grigg 0ce0280b26 CI: Fix rustdoc rendering to handle workspace
`cargo rustdoc` only works for a single package. To render docs for
a workspace while passing config options to `rustdoc`, we need to use
the `RUSTDOCFLAGS` environment variable.

We also add several other flags to handle the switch to `cargo doc`:
- `--no-deps` ensures we only build packages in the workspace.
- `--enable-index-page` (unstable) adds a landing page showing the list
  of rendered crate docs.
2022-02-04 01:03:52 +00:00
Jack Grigg 4eb464e49d book: Render latest rustdoc in book subdir 2021-07-09 20:12:40 +01:00
Jack Grigg a388726ce9 CI: Build book with latest mdbook
`mdbook-katex` is installed from crates.io, and if it doesn't use the
same version of `mdbook` it can cause build issues.
2021-06-04 22:41:25 +01:00
Jack Grigg 30b1c0c1ad Use mdbook 0.4.5
https://blog.rust-lang.org/2021/01/04/mdbook-security-advisory.html
2021-01-09 02:37:05 +00:00
Jack Grigg a9146ae472 book: Add KaTeX support 2020-12-10 20:44:50 +00:00
Jack Grigg cb54205600 Actions workflow to deploy book to GH Pages 2020-12-04 16:14:54 +00:00