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

Reference/Path to module aliases of unexpanded/unavailable modules link to 404 (without warnings) #1109

Open
panglesd opened this issue Apr 15, 2024 · 1 comment

Comments

@panglesd
Copy link
Collaborator

Suppose you have the following file:

(* test.ml *)
module X = Stdlib
module Y = X

module Z = struct
  let x = 1
end

module T = Z

(** {!X} {!Y} {!Z} {!T} *)

and you compile its doc without access to stdlib:

$ odoc compile test.cmt
$ odoc link test.odoc
$ odoc html-generate test.odocl -o html

Then no warnings will be emitted, but the first two references (to X and Y) will generate a link to a non existent page. The references to Z and T both link to the expansion of Z.

Linked with #1106.

@panglesd
Copy link
Collaborator Author

This is also triggered outside of references. For instance:

module type A = sig
  module X = Stdlib
  module Y := X
end

If Stdlib is not in the path, clicking on X in module Y := X will lead to a 404 page.

@panglesd panglesd changed the title Reference to module aliases of unexpanded/unavailable modules link to 404 (without warnings) Reference/Path to module aliases of unexpanded/unavailable modules link to 404 (without warnings) Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant