Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix MD book generation #814

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Fix MD book generation #814

merged 1 commit into from
Feb 26, 2024

Conversation

adria0
Copy link

@adria0 adria0 commented Feb 22, 2024

It seems that the last nightly does not work very well to compile mdbook (patched rev 5830c9555a4dc051675d17f1fcb04dd0920543e8) nor to compile halo2 (that is fixed to 1.60).

This PR fixes the toolchain to properly compile the tools for generating the documentation, because seems that cargo install uses the rust-toolchain.toml file by default. Also, having a fixed toolchain is not a bad idea to ensure proper generation of documentation IMO.

BTW, I had to remove [output.katex] since it was failing here because the received JSON was not an array of two elements. Anyway seems that html is properly generated. cc/ @HollowMan6

@adria0 adria0 marked this pull request as ready for review February 26, 2024 10:37
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed the changes from upstream to this commit.

Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

@daira daira merged commit 7df93fd into zcash:main Feb 26, 2024
19 of 20 checks passed
YaoJGalteland pushed a commit to QED-it/halo2 that referenced this pull request May 29, 2024
YaoJGalteland pushed a commit to QED-it/halo2 that referenced this pull request May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants