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

Problem generating index.mld pages #717

Closed
bobbypriam opened this issue Apr 23, 2018 · 1 comment · Fixed by ocaml/opam-repository#12323
Closed

Problem generating index.mld pages #717

bobbypriam opened this issue Apr 23, 2018 · 1 comment · Fixed by ocaml/opam-repository#12323
Assignees

Comments

@bobbypriam
Copy link
Contributor

I'm playing around with generating manuals via Dune (1.0+beta20). Suppose I have the following files in a directory:

hello_world.ml

let add x y = x + y

hello_world.mli

val add : int -> int -> int
(** [add x y] is x + y. *)

hello_world.opam

opam-version: "1.2"
name: "hello_world"
version: "0.1"
maintainer: "Name <email>"

jbuild

(jbuild_version 1)

(library
  ((name hello_world)
   (public_name hello_world)
   (libraries ())))

(documentation ())

index.mld

Test index.

Running jbuilder build @doc fails with:

$ jbuilder build @doc
Multiple rules generated for _build/default/_doc/_odoc/pkg/hello_world/page-index.odoc:
- <internal location>
- <internal location>

By "fails" I mean it doesn't generate anything (_build only contains log).

Note that this doesn't happen if I rename index.mld to e.g. test.mld. It will run successfully with the page available at _build/default/_doc/_html/hello_world/test.html.

Do you have any idea where I had messed up?

@rgrinberg
Copy link
Member

That sounds like a bug. Will investigate.

@rgrinberg rgrinberg self-assigned this Apr 23, 2018
rgrinberg added a commit to rgrinberg/jbuilder that referenced this issue Apr 28, 2018
Extensions should be removed from the map of basenames to mld paths
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

Successfully merging a pull request may close this issue.

2 participants