iced icon indicating copy to clipboard operation
iced copied to clipboard

Building the documentation ends with an error

Open JL710 opened this issue 11 months ago • 1 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues.

Is this issue related to iced?

  • [X] 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 avatar Feb 25 '24 19:02 JL710

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

Koranir avatar Feb 26 '24 02:02 Koranir