Warning: Cannot find Stdlib

[hbr]

When creating my documentation via odoc I usually get the warning that odoc cannot find module Stdlib. The reason seams to be that e.g. String.t is within the type of a function which is resolved to Stdlib.String.t (which is correct), but the documentation for Stdlib cannot be referenced.

Is there a way to avoid this warning or link to the documentation of Stdlib?

[Julow]

The documentation for the stdlib isn't built, Odoc can't reference it. Dune doesn't build the documentation of dependencies and so the documentation is incomplete.

For now, Odig and the new documentation website build the doc correctly.

On the other hand, the incomplete documentation is a lot smaller (doesn't contain all the transitive dependencies) and still readable.

[hbr]

The behavior is the expected one. I didn’t want odoc to build documentation of the standard library. But why report this as a warning. Nothing is wrong. I want to build the documentation for my library, my library uses types for the standard library. There is no reason to report any error here.

…

On 10 Feb 2022, at 11:51, Jules Aguillon ***@***.***> wrote: The documentation for the stdlib isn't built, Odoc can't reference it. Dune doesn't build the documentation of dependencies and so the documentation is incomplete. For now, Odig and the new documentation website <https://v3.ocaml.org/packages> build the doc correctly. On the other hand, the incomplete documentation is a lot smaller (doesn't contain all the transitive dependencies) and still readable. — Reply to this email directly, view it on GitHub <#825 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACX25GNYYFZSUMDG7PYALLU2OKCBANCNFSM5OABXIJQ>. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.

[Julow]

Agree. It is planned to make these errors a lot less verbose. Also, they are not turn into errors with --warn-error.

[dbuenzli]

What @hbr is saying, is that currently odoc's error reporting is unusable, I struggle with that every day (I thought we had an issue about this but it doesn't seem so).

We need a mode where external references do not trigger warning. E.g.

[doc-build odoc][0]: (brzo log --id 35)
File "/Users/dbuenzli/sync/repos/note/_b0/brzo/ocaml-doc/odoc/note/note.odoc":
Warning: Couldn't find the following modules:
  Stdlib
File "/Users/dbuenzli/sync/repos/note/src/note.mli", line 10, characters 7-15:
Warning: Failed to resolve reference unresolvedroot(React) Couldn't find "React"