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

ambient_ui api docs not working #1028

Open
FredrikNoren opened this issue Oct 3, 2023 · 6 comments
Open

ambient_ui api docs not working #1028

FredrikNoren opened this issue Oct 3, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@FredrikNoren
Copy link
Contributor

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

@FredrikNoren FredrikNoren added the documentation Improvements or additions to documentation label Oct 3, 2023
@FredrikNoren FredrikNoren added this to the 0.3.1 milestone Oct 3, 2023
@philpax
Copy link
Contributor

philpax commented Oct 3, 2023

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
Copy link
Contributor

philpax commented Oct 6, 2023

@philpax
Copy link
Contributor

philpax commented Oct 6, 2023

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
Copy link
Contributor

philpax commented Oct 18, 2023

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

@philpax philpax modified the milestones: 0.3.1, 0.4 Oct 18, 2023
@philpax philpax reopened this Oct 24, 2023
@philpax
Copy link
Contributor

philpax commented Oct 24, 2023

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
Copy link
Contributor

philpax commented Oct 24, 2023

See also #1112.

@philpax philpax removed this from the 0.3.1 milestone Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants