Use kimchi/README.md in the kimchi crate rustdoc #612
Closed
Conversation
This file contains hidden or 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
Using README.md causes this crate to fail to build when specified as an external dependency, since it can't find ../../README.md.
|
#555 should fix your issue I believe. Also, we should really create releases and publish them on crates.io. I think we'll investigate that next. |
|
#555 will fix the kimchi crate, but break the circuit-construction crate in exactly the same way. Publishing it on crates.io would be ideal, but it would also be nice to have a fix for the interim. |
|
you don't need to import the circuit-construction crate in mina so that should be fine right for now right? Let me know, I'm hopping we find a solution where we can keep examples in the main README |
|
This works, thanks! |
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.
As part of MinaProtocol/mina#11212, I'm moving some rust deps from a git submodule to a cargo git dep. However, the
kimchicrate fails to build, since it can't find ../../README.md in this case.I've moved the example into the kimchi crate README.md and used that.