Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0005852OCaml-for ocamlbuild use https://github.com/ocaml/ocamlbuild/issuespublic2012-12-13 01:022017-03-03 17:03
Reportermikhail.glushenkov 
Assigned To 
PrioritynormalSeverityfeatureReproducibilityalways
StatusresolvedResolutionsuspended 
PlatformOSOS Version
Product Version4.00.1 
Target VersionFixed in Version 
Summary0005852: Ocamlbuild does not pass .ml files to ocamldoc when there is an .mli file present
DescriptionI 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.
TagsNo tags attached.
Attached Files

- Relationships
related to 0004622resolvedgasche Ocamlbuild needs support for generating documentation from implementation files 

-  Notes
(0017537)
doligez (administrator)
2017-03-03 11:42

ocamlbuild is now a separate project that lives on GitHub.
PR transferred to https://github.com/ocaml/ocamlbuild/issues/206 [^]

- Issue History
Date Modified Username Field Change
2012-12-13 01:02 mikhail.glushenkov New Issue
2013-06-28 18:09 doligez Status new => acknowledged
2017-02-23 16:34 doligez Category OCamlbuild (the tool) => for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues [^]
2017-02-23 16:44 doligez Category for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues [^] => -for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues [^]
2017-03-03 11:42 doligez Note Added: 0017537
2017-03-03 11:42 doligez Status acknowledged => resolved
2017-03-03 11:42 doligez Resolution open => suspended
2017-03-03 17:03 doligez Relationship added related to 0004622


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker