Fix MD book generation #814
Merged
+7
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daira
reviewed
Feb 26, 2024
| @@ -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 | |||
There was a problem hiding this comment.
I reviewed the changes from upstream to this commit.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 installuses therust-toolchain.tomlfile 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