You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm encountering an issue when generating documentation on docs.rs for my project, ez-ffmpeg. The project depends on ffmpeg-sys-next and in version 0.1.1 I've enabled its build feature. This feature is necessary because the default Linux environment does not include FFmpeg 7.1, resulting in missing items like ffmpeg_sys_next::AVChannelOrder::AV_CHANNEL_ORDER_UNSPEC.
To resolve these missing components, the build feature compiles FFmpeg 7.1 during the build process. However, docs.rs restricts external network access, and the build script fails when attempting to clone the FFmpeg source from GitHub. An excerpt from the logs is as follows:
Cloning into 'ffmpeg-7.1'...
fatal: unable to access 'https://github.com/FFmpeg/FFmpeg/': Could not resolve host: github.com
...
called `Result::unwrap()` on an `Err` value: Custom { kind: Other, error: "fetch failed" }
I understand that the network restrictions on docs.rs are in place for security and reliability, but this leaves me with no alternative method to generate documentation for ez-ffmpeg. Is there a recommended workaround or configuration option (for example, an environment variable or a docs.rs-specific flag) that would allow skipping or handling the network-dependent build step? Any guidance or suggestions on how to proceed would be greatly appreciated.
using https://docs.rs/about/metadata to build a version of the crate that doesn't need the third party source, and builds just what's needed for the docs. This would be what you call " allow skipping or handling the network-dependent build step", and would be a change to ffmpeg-sys-next.
Often it also helps to look at how the other library (in this case, ffmpeg-sys-next) builds its docs.
Crate name
ez-ffmpeg
Build failure link
https://docs.rs/crate/ez-ffmpeg/0.1.1/builds/1836231
Additional details
I'm encountering an issue when generating documentation on docs.rs for my project,
ez-ffmpeg
. The project depends on ffmpeg-sys-next and in version 0.1.1 I've enabled itsbuild
feature. This feature is necessary because the default Linux environment does not include FFmpeg 7.1, resulting in missing items likeffmpeg_sys_next::AVChannelOrder::AV_CHANNEL_ORDER_UNSPEC
.To resolve these missing components, the
build
feature compiles FFmpeg 7.1 during the build process. However, docs.rs restricts external network access, and the build script fails when attempting to clone the FFmpeg source from GitHub. An excerpt from the logs is as follows:I understand that the network restrictions on docs.rs are in place for security and reliability, but this leaves me with no alternative method to generate documentation for
ez-ffmpeg
. Is there a recommended workaround or configuration option (for example, an environment variable or a docs.rs-specific flag) that would allow skipping or handling the network-dependent build step? Any guidance or suggestions on how to proceed would be greatly appreciated.Environment:
Thank you for your help!
The text was updated successfully, but these errors were encountered: