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

Build in custom docker image #315

Open
yaa110 opened this issue Mar 9, 2019 · 4 comments · May be fixed by #1193
Open

Build in custom docker image #315

yaa110 opened this issue Mar 9, 2019 · 4 comments · May be fixed by #1193
Labels
A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature E-medium Effort: This requires a fair amount of work

Comments

@yaa110
Copy link

yaa110 commented Mar 9, 2019 •
edited
Loading

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?
@QuietMisdreavus
Copy link
Member

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?

@yaa110 yaa110 mentioned this issue Jun 26, 2019
Closed
@jyn514
Copy link
Member

jyn514 commented Feb 1, 2020

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

@jyn514 jyn514 mentioned this issue Jun 3, 2020
Closed
@pietroalbini
Copy link
Member

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.

@jyn514 jyn514 added A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work. labels Jul 27, 2020
@jyn514
Copy link
Member

jyn514 commented Jul 27, 2020

Blocked on rust-lang/rustwide#32

@jyn514 jyn514 removed the S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work. label Aug 17, 2020
@devsnek devsnek linked a pull request Nov 24, 2020 that will close this issue
Open
@jyn514 jyn514 mentioned this issue Apr 21, 2021
Closed
@syphar syphar mentioned this issue May 30, 2022
Closed
@syphar syphar mentioned this issue Jun 23, 2022
Closed
@syphar syphar mentioned this issue Sep 25, 2023
Closed
@syphar syphar added the E-medium Effort: This requires a fair amount of work label Oct 24, 2023
This was referenced Aug 18, 2024
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature E-medium Effort: This requires a fair amount of work
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add custom docker image support devsnek/docs.rs
5 participants
@syphar @pietroalbini @yaa110 @QuietMisdreavus @jyn514