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

API docs for wry v0.35.0 is unavailable on docs.rs #1096

Closed
1 of 2 tasks
rhysd opened this issue Nov 27, 2023 · 6 comments · Fixed by #1098
Closed
1 of 2 tasks

API docs for wry v0.35.0 is unavailable on docs.rs #1096

rhysd opened this issue Nov 27, 2023 · 6 comments · Fixed by #1098
Labels
help wanted Help is requested to fix this issue type: bug

Comments

@rhysd
Copy link
Contributor

rhysd commented Nov 27, 2023

Describe the bug

Building API docs on docs.rs failed. API docs for v0.35.0 is not available.

Build log: https://docs.rs/crate/wry/0.35.0/builds/988909

Steps To Reproduce

N/A

Expected behavior

Documentation for v0.35.0 can be referred on docs.rs

Screenshots

image

Platform and Versions (please complete the following information):
OS: N/A
Rustc: N/A

Would you want to assign yourself to resolve this bug?

  • Yes
  • No

Additional context

Errors reported in the build log:

[INFO] [stderr] error[E0433]: failed to resolve: use of undeclared crate or module `gdkx11`
[INFO] [stderr]     --> src/lib.rs:1151:9
[INFO] [stderr]      |
[INFO] [stderr] 1151 |     use gdkx11::glib::Cast;
[INFO] [stderr]      |         ^^^^^^ use of undeclared crate or module `gdkx11`
[INFO] [stderr] 
[INFO] [stderr] error[E0433]: failed to resolve: use of undeclared crate or module `gtk`
[INFO] [stderr]     --> src/lib.rs:1136:8
[INFO] [stderr]      |
[INFO] [stderr] 1136 |     W: gtk::prelude::IsA<gtk::Container>;
[INFO] [stderr]      |        ^^^ use of undeclared crate or module `gtk`
[INFO] [stderr] 
[INFO] [stderr] error[E0433]: failed to resolve: use of undeclared crate or module `gtk`
[INFO] [stderr]     --> src/lib.rs:1149:8
[INFO] [stderr]      |
[INFO] [stderr] 1149 |     W: gtk::prelude::IsA<gtk::Container>,
[INFO] [stderr]      |        ^^^ use of undeclared crate or module `gtk`
[INFO] [stderr] 
[INFO] [stderr] error[E0412]: cannot find type `InnerWebView` in this scope
[INFO] [stderr]     --> src/lib.rs:1171:12
[INFO] [stderr]      |
[INFO] [stderr] 1171 |   webview: InnerWebView,
[INFO] [stderr]      |            ^^^^^^^^^^^^ not found in this scope
[INFO] [stderr] 
[INFO] [stderr] error[E0433]: failed to resolve: use of undeclared crate or module `gtk`
[INFO] [stderr]     --> src/lib.rs:1136:26
[INFO] [stderr]      |
[INFO] [stderr] 1136 |     W: gtk::prelude::IsA<gtk::Container>;
[INFO] [stderr]      |                          ^^^ use of undeclared crate or module `gtk`
[INFO] [stderr] 
[INFO] [stderr] error[E0433]: failed to resolve: use of undeclared crate or module `gtk`
[INFO] [stderr]     --> src/lib.rs:1149:26
[INFO] [stderr]      |
[INFO] [stderr] 1149 |     W: gtk::prelude::IsA<gtk::Container>,
[INFO] [stderr]      |                          ^^^ use of undeclared crate or module `gtk`
[INFO] [stderr] 
[INFO] [stderr] Some errors have detailed explanations: E0412, E0433.
[INFO] [stderr] For more information about an error, try `rustc --explain E0412`.
[INFO] [stderr] error: could not document `wry`
[INFO] [stderr] 
[INFO] [stderr] Caused by:
[INFO] [stderr]   process didn't exit successfully: `/opt/rustwide/rustup-home/toolchains/nightly-x86_64-unknown-linux-gnu/bin/rustdoc --edition=2021 --crate-type lib --crate-name wry src/lib.rs --target x86_64-unknown-linux-gnu -o /opt/rustwide/target/x86_64-unknown-linux-gnu/doc --cfg 'feature="file-drop"' --cfg 'feature="protocol"' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat -C metadata=5cec3cd8eb83027a -L dependency=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps -L dependency=/opt/rustwide/target/debug/deps --extern http=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libhttp-05c14da7421f4629.rmeta --extern libc=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/liblibc-38c0088155dba44d.rmeta --extern log=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/liblog-7429a03555bcf241.rmeta --extern once_cell=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libonce_cell-3810e71ba6b5ea8b.rmeta --extern raw_window_handle=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libraw_window_handle-0e8010c39360f59d.rmeta --extern serde=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libserde-c4eea3c00534bc11.rmeta --extern serde_json=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libserde_json-37085cd1fdf87490.rmeta --extern thiserror=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/libthiserror-6b9da5ff673c6c25.rmeta --extern url=/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/deps/liburl-216f9f0917650058.rmeta --extern-html-root-url 'http=https://docs.rs/http/0.2.11/x86_64-unknown-linux-gnu' --extern-html-root-url 'libc=https://docs.rs/libc/0.2.150/x86_64-unknown-linux-gnu' --extern-html-root-url 'log=https://docs.rs/log/0.4.20/x86_64-unknown-linux-gnu' --extern-html-root-url 'once_cell=https://docs.rs/once_cell/1.18.0/x86_64-unknown-linux-gnu' --extern-html-root-url 'raw_window_handle=https://docs.rs/raw-window-handle/0.5.2/x86_64-unknown-linux-gnu' --extern-html-root-url 'serde=https://docs.rs/serde/1.0.193/x86_64-unknown-linux-gnu' --extern-html-root-url 'serde_json=https://docs.rs/serde_json/1.0.108/x86_64-unknown-linux-gnu' --extern-html-root-url 'thiserror=https://docs.rs/thiserror/1.0.50/x86_64-unknown-linux-gnu' --extern-html-root-url 'url=https://docs.rs/url/2.4.1/x86_64-unknown-linux-gnu' -Zunstable-options --cfg docsrs -Z unstable-options --emit=invocation-specific --resource-suffix -20231120-1.76.0-nightly-3a85a5cfe --static-root-path /-/rustdoc.static/ --cap-lints warn --extern-html-root-takes-precedence --crate-version 0.35.0 --cfg linux` (exit status: 1)
@rhysd
Copy link
Contributor Author

rhysd commented Nov 27, 2023

I haven't confirmed, but os-webview feature seems missing in [package.metadata.docs.rs] which was added at #1077.

@wusyong wusyong added the help wanted Help is requested to fix this issue label Nov 27, 2023
@wusyong
Copy link
Member

wusyong commented Nov 27, 2023

I guess I forgot to add it there. While we can add a PR to fix it pretty soon, can anyone confirm it can be built in the doc.rs container by this?

@rhysd
Copy link
Contributor Author

rhysd commented Nov 27, 2023

Sorry I don't have same environment to build documents as docs.rs. How to try it is desribed in the following document:

https://github.com/rust-lang/docs.rs/blob/master/README.md#getting-started

From the comment in #1032, @FabianLars may have the pipeline environment.

@FabianLars
Copy link
Member

i do, i'll check in a minute :)

@FabianLars
Copy link
Member

There's a duplicate #![cfg_attr(docsrs, feature(doc_cfg))] line in lib.rs - once one of them is removed it builds again after adding the os-webview feature flag.

@rhysd
Copy link
Contributor Author

rhysd commented Nov 27, 2023

I created #1099 to add a CI job to run cargo doc on CI as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Help is requested to fix this issue type: bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants