docs.rs icon indicating copy to clipboard operation
docs.rs copied to clipboard

Build in custom docker image

Open yaa110 opened this issue 6 years ago • 4 comments

Please consider nginx crate docs: https://docs.rs/nginx/0.4.0/nginx/

as you can see it is not built because the crate needs some modification in the OS:

sed -i 's:# define IPPORT_RESERVED:// #define IPPORT_RESERVED:' /usr/include/netdb.h

Is it possible to provide a custom docker image to build docs for such crates?

yaa110 avatar Mar 09 '19 11:03 yaa110

Not yet, but a migration to Docker is planned for the "docs.rs 2.0" effort. Perhaps it wouldn't be too much extra effort to allow people to provide a custom image base instead of whatever default we plan to use?

QuietMisdreavus avatar Mar 19 '19 13:03 QuietMisdreavus

Rustwide allows custom docker images, I wonder if we could allow that to be configured in package.metadata.docs.rs.

jyn514 avatar Feb 01 '20 16:02 jyn514

That's not going to work: rustwide currently needs some file inside the Docker image to work (currently only the entrypoint iirc). We'd need to change rustwide to instead bundle the entrypoint in itself and mount it inside the container at startup.

pietroalbini avatar Jun 03 '20 18:06 pietroalbini

Blocked on https://github.com/rust-lang/rustwide/pull/32

jyn514 avatar Jul 27 '20 04:07 jyn514