Skip to content

Failure generating documentation with multiple lightning libraries #689

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

Closed
jkczyz opened this issue Sep 11, 2020 · 4 comments
Closed

Failure generating documentation with multiple lightning libraries #689

jkczyz opened this issue Sep 11, 2020 · 4 comments

Comments

@jkczyz
Copy link
Contributor

jkczyz commented Sep 11, 2020

Seeing the following failure after #618 was merged.

$ cargo doc
error: The library `lightning` is specified by packages `lightning v0.0.11 (/Users/jkczyz/src/rust-lightning/lightning)` and `lightning-c-bindings v0.0.1 (/Users/jkczyz/src/rust-lightning/lightning-c-bindings)` but can only be documented once. Consider renaming or marking one of the targets as `doc = false`.

Workaround is to use cargo doc -p lightning.

@julianknutsen
Copy link

Are docs built as part of CI? I couldn't find it in the build script anywhere but seems like an easy add.

@TheBlueMatt
Copy link
Collaborator

Ah I never use cargo doc. I just stepped out but I think the fix is just replace the lib name in lightning-c-bindings/Cargo.toml and then update the scripts that specify a binary name. Maybe liblightningbindings or liblightningc or libldk?

@TheBlueMatt
Copy link
Collaborator

I suppose not :). doctests are run as a part of cargo test, but I guess cargo doc can fail in interesting ways.

TheBlueMatt added a commit to TheBlueMatt/rust-lightning that referenced this issue Sep 12, 2020
@TheBlueMatt
Copy link
Collaborator

Should be fixed in #688.

TheBlueMatt added a commit to TheBlueMatt/rust-lightning that referenced this issue Sep 12, 2020
TheBlueMatt added a commit to TheBlueMatt/rust-lightning that referenced this issue Sep 13, 2020
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

No branches or pull requests

4 participants
@TheBlueMatt @jkczyz @julianknutsen and others