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.

Sign up for GitHub

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

Jump to bottom

docs for cognitive-services-speech-sdk-rs failing to build #1376

Closed
adambezecny opened this issue Apr 21, 2021 · 6 comments
Closed

docs for cognitive-services-speech-sdk-rs failing to build #1376

adambezecny opened this issue Apr 21, 2021 · 6 comments
Labels
C-build-failure Category: This is a crate that failed to build S-waiting-on-crate-author Status: This is a build failure that has to be fixed by the crate author, not the docs.rs team

Comments

@adambezecny
Copy link

Crate name: cognitive-services-speech-sdk-rs
Build failure link: https://docs.rs/crate/cognitive-services-speech-sdk-rs/0.1.1/builds/380044

Additional details:
failing to build because custom build script is trying to download native dependencies (MS Speech SDK) from github. I originally had these dependencies in lib directly but then I was not able to publish lib to crates.io since it allows only 10 MB in total per lib.

Please advise how to proceed to build documentation for this crate. I cannot include libs directly due to 10 MB limitation and I cannot download them due to docs.rs buildsend box limitation.
@jyn514
Copy link
Member

jyn514 commented Apr 21, 2021 •
edited
Loading

You might be able to use #315 if it's ever finished. I don't have suggestions other than that.

@adambezecny
Copy link
Author

hi, can you provide more info on this option? At a first glance I am little bit in the mist. Based on pasted link it does not seem like viable. Rustdoc is just bunch of static html files. Any chance to load these files directly into https://docs.rs/ ? I am very keen to have this doc published. Crate I have created supports official MS Speech SDK in very comprehensive way, it would be pity not to have it documented properly.

@jyn514
Copy link
Member

jyn514 commented Apr 22, 2021

I don't know what you mean by "load these files directly" - do you mean compile the docs on your own and upload them? That's #93.

I think I'd recommend hosting your own documentation on a separate website and linking to that in the readme. Docs.rs defaults to showing the readme if the documentation didn't build: https://docs.rs/deno_runtime.

@jyn514 jyn514 added C-build-failure Category: This is a crate that failed to build S-waiting-on-crate-author Status: This is a build failure that has to be fixed by the crate author, not the docs.rs team labels Jun 12, 2021
@jyn514
Copy link
Member

jyn514 commented Jun 21, 2021

@adambezecny are you planning to work on this? If not there's not much point in us tracking it ... the features you've requested are already tracked elsewhere.

@adambezecny
Copy link
Author

hi, working on what exactly? docs.rs has very sever limitations, like build cannot download any external dependencies, file system is read only. Makes very hard to build docs for crates which are using these things. I had to host documentation somewhere else. I guess this can be closed than. thx

@jyn514
Copy link
Member

jyn514 commented Jun 21, 2021

Got it. Sorry for the trouble.

@jyn514 jyn514 closed this as completed Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-build-failure Category: This is a crate that failed to build S-waiting-on-crate-author Status: This is a build failure that has to be fixed by the crate author, not the docs.rs team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@adambezecny @jyn514