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

Jump to bottom

Ocamlbuild needs support for generating documentation from implementation files #4622

Closed
vicuna opened this issue Oct 14, 2008 · 4 comments
Closed

Ocamlbuild needs support for generating documentation from implementation files #4622

vicuna opened this issue Oct 14, 2008 · 4 comments
Assignees
@gasche
Labels
feature-wish ocamlbuild suspended

Comments

@vicuna
Copy link

vicuna commented Oct 14, 2008

Original bug ID: 4622
Reporter: dario
Assigned to: @gasche
Status: resolved (set by @damiendoligez on 2017-03-03T16:06:57Z)
Resolution: suspended
Priority: normal
Severity: feature
Version: 3.10.2
Category: -for ocamlbuild use https://github.com/ocaml/ocamlbuild/issues
Related to: #5852
Monitored by: @ygrek @jberdine @hcarty

Bug description

According to the Ocamlbuild manual, "generating documentation in formats other than HTML or from implementations is not supported". However, the latter feature is very useful, especially for projects that are already using Ocamlbuild for all other purposes.
@vicuna
Copy link
Author

vicuna commented Oct 16, 2008

Comment author: dario

Actually, this seems to be more of a documentation issue: the Ocamlbuild manual is misleading in this regard. Nevertheless, being able to merge the documentation from mli and ml files is also a welcome feature.

@vicuna
Copy link
Author

vicuna commented Oct 16, 2009

Comment author: @ygrek

correct me if I am wrong but looks like adding the corresponding flags to ocamldoc is enough :

 flag ["ocaml"; "doc"] (S[A"-short-functors"; A"-sort"; A"-m"; A"A"]);

@vicuna
Copy link
Author

vicuna commented Jun 22, 2011

Comment author: @hcarty

The "-m A" arguments are part of the solution. They are not enough though, as ocamlbuild only passes the .mli to ocamldoc if a .mli exists.

@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#226

@vicuna vicuna closed this as completed Mar 3, 2017
@vicuna vicuna mentioned this issue Mar 14, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gasche gasche

Labels
feature-wish ocamlbuild suspended
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gasche @vicuna