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

Correct document generation in docs.rs #22

Closed
ldm0 opened this issue Jun 24, 2020 · 1 comment · Fixed by #24
Closed

Correct document generation in docs.rs #22

ldm0 opened this issue Jun 24, 2020 · 1 comment · Fixed by #24
Assignees
Labels
enhancement New feature or request

Comments

@ldm0
Copy link
Collaborator

ldm0 commented Jun 24, 2020

It is a really interesting problem that the docs.rs successfully generated documentation for version 0.1.0 but failed to generate documentation for version 0.2.0.

That's because the 0.1.0 version tried to probe FFmpeg in the system if no user-compiled FFmpeg is used. But 0.2.0 just uses the provided FFmpeg or compiled FFmpeg by itself. The reason why 0.1.0 successfully generates bindings is that the docs.rs' docker image contains libav* libraries, you can check rust-lang/docs.rs#851 for the discussion.

So now for 0.2.0 to successfully generate useful documentation, there are several hacks need to be done on the build script. And the most important thing is docs.rs detection in build script. But currently it's not possible. So I filed a PR to fix it in docs.rs, so currently we are blocking on it's merge.

@ldm0 ldm0 self-assigned this Jun 24, 2020
@ldm0 ldm0 added blocked blocked on something like another PR enhancement New feature or request labels Jun 24, 2020
@ldm0
Copy link
Collaborator Author

ldm0 commented Jun 24, 2020

With rust-lang/docs.rs#852 got merged, this is not blocked any more.

@ldm0 ldm0 removed the blocked blocked on something like another PR label Jun 24, 2020
@ldm0 ldm0 closed this as completed in #24 Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant