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

Ocamlbuild does not pass .ml files to ocamldoc when there is an .mli file present #5852

Closed
vicuna opened this issue Dec 13, 2012 · 1 comment

Comments

@vicuna
Copy link

vicuna commented Dec 13, 2012

Original bug ID: 5852
Reporter: mikhail.glushenkov
Status: resolved (set by @damiendoligez on 2017-03-03T10:42:36Z)
Resolution: suspended
Priority: normal
Severity: feature
Version: 4.00.1
Category: -for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues
Related to: #4622
Monitored by: @gasche kerneis @hcarty

Bug description

I want to include source code in my generated docs. This works when I invoke ocamldoc on the command-line like this:

ocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir
. However, I'm having troubles integrating this with ocamlbuild.

I'm using the following code in myocamlbuild.ml:

open Ocamlbuild_plugin;;

dispatch begin function
  | After_options ->
      Options.ocamldoc := S[A"ocamldoc"; A"-keep-code"; A"-colorize-code"]
  | _ -> ()
end

But this only includes the source for files with no corresponding interface file - it looks like ocamlbuild refuses to pass .ml files to ocamldoc when there is an .mli file present. It'd be nice if it was possible to integrate ocamldoc -keep-code with ocamlbuild.

@vicuna
Copy link
Author

vicuna commented Mar 3, 2017

Comment author: @damiendoligez

ocamlbuild is now a separate project that lives on GitHub.
PR transferred to ocaml/ocamlbuild#206

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant