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

Building the documentation ends with an error #2290

Open
2 tasks done
JL710 opened this issue Feb 25, 2024 · 1 comment
Open
2 tasks done

Building the documentation ends with an error #2290

JL710 opened this issue Feb 25, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@JL710
Copy link

JL710 commented Feb 25, 2024

Is there an existing issue for this?

  • I have searched the existing issues.

Is this issue related to iced?

  • My hardware is compatible and my graphics drivers are up-to-date.

What happened?

I tried to build the documentation with cargo doc --open. That process did not run succesfull and ended with errors.

What is the expected behavior?

The documentation is beeing build and opens.

Version

master

Operating System

Linux

Do you have any log output?

Documenting iced v0.13.0-dev (/somepath/iced)
error: unresolved link to `crate::widget::Canvas`
   --> src/sandbox.rs:47:24
    |
47  | /// [`Canvas widget`]: crate::widget::Canvas
    |                        ^^^^^^^^^^^^^^^^^^^^^ no item named `Canvas` in module `widget`
    |
note: the lint level is defined here
   --> src/lib.rs:159:5
    |
159 |     rustdoc::broken_intra_doc_links
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: unresolved link to `crate::widget::Svg`
  --> src/sandbox.rs:50:21
   |
50 | /// [`Svg` widget]: crate::widget::Svg
   |                     ^^^^^^^^^^^^^^^^^^ no item named `Svg` in module `widget`

error: unresolved link to `crate::widget::Canvas`
  --> src/application.rs:52:17
   |
52 | /// [`Canvas`]: crate::widget::Canvas
   |                 ^^^^^^^^^^^^^^^^^^^^^ no item named `Canvas` in module `widget`

error: unresolved link to `crate::widget::Canvas`
  --> src/settings.rs:47:21
   |
47 |     /// [`Canvas`]: crate::widget::Canvas
   |                     ^^^^^^^^^^^^^^^^^^^^^ no item named `Canvas` in module `widget`

error: could not document `iced`
@JL710 JL710 added the bug Something isn't working label Feb 25, 2024
@Koranir
Copy link
Contributor

Koranir commented Feb 26, 2024

You need to run cargo doc --all-features --open to build the docs right now I believe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants