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

Replace the ironfish-primitives and ironfish-proofs READMEs with the workspace README #9

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

andiflabs
Copy link

cargo publish is failing because the crate docs are generated from this line:

#![doc = include_str!("../../README.md")]

and apparently cargo publish does not like when files outside of the crate root are referenced, even if the file belongs to the same cargo workspace.

To workaround this problem, the workspace README has been symliked to the crates' README, so that include_str! can point to a file within the crate directory.

@andiflabs andiflabs merged commit a626b5a into master Oct 28, 2024
3 of 22 checks passed
@andiflabs andiflabs deleted the andrea/fix-docs-readme branch October 28, 2024 18:19
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