AmbientRun / Ambient

The multiplayer game engine
https://ambient.run
Apache License 2.0
3.8k stars 124 forks source link

ambient_ui api docs not working #1028

Open FredrikNoren opened 1 year ago

FredrikNoren commented 1 year ago

For some reason the docs for ambient_ui are not working on docs.rs

philpax commented 1 year ago

The package gets published, as you can see: https://crates.io/crates/ambient_ui/0.3.0-rc.4a

but no attempt is made by docs.rs to build it: https://docs.rs/crate/ambient_ui/latest/builds

philpax commented 1 year ago

I've asked about this at https://rust-lang.zulipchat.com/#narrow/stream/356853-t-docs-rs/topic/Crate.20docs.20not.20being.20built/near/395253689 and hope to get a response soon.

philpax commented 1 year ago

Ok, it's very likely because ambient_ui depends on native crates that haven't been published. We can try:

1) patching the crate before publish to remove the native dependencies 2) publishing the native dependencies, but only up to the point where it's necessary and before it gets to crates-with-Git-dependencies 3) giving up and just self-hosting docs that we control the full environment for

If you're planning on releasing 0.3.1 in the next week, 3) is probably your best bet ( #1029 ).

philpax commented 1 year ago

Tried to fix this using option 2, but couldn't get it working. Leaving this for later.

philpax commented 1 year ago

This can't be fixed until we remove our Git dependencies and can publish the runtime crates again. ambient_ui depends on ambient_element, which depends on ambient_core, which depends on all of the unpublished runtime crates.

philpax commented 1 year ago

See also #1112.