search

gasche / manual-ocamlbuild

A new reference manual for the ocamlbuild tool
Other
67 stars 15 forks source link

Add an example where documentation is generated using ocamldoc #25

Closed Armael closed 8 years ago

Armael commented 8 years ago

I want to add an example of how to build with a custom ocamldoc plugin, but before that, we need an example using standard ocamldoc, IMO. Hence this PR.

Nb: the target for generating manpages does not work (never used that before myself, I just used the target from the manual). This should be fixed before merging, but I don't know how.

gasche commented 8 years ago

Indeed, manpage target seems broken. You have to manually add the manpage tag for it to work, so just adding -tag manpage to your Makefile should do. To fix the issue, you have to change the man-related rule in ocaml_specific.ml, which probably means passing some information to the ocamldoc-related functions in ocaml_compiler.ml. Could you send a pull request against the new ocamlbuild github repository?

gasche commented 8 years ago

(We could merge this PR right now, but I feel it's better to wait for the man issue to be sorted out. Do say it if you disagree and I'll merge.)

Armael commented 8 years ago

Agreed. I'm willing to do the PR to fix the issue in ocamlbuild, before merging this one. I submitted the following issue on ocamlbuild's repo to discuss the thing, as I'm a bit unsure on how to do this.

Armael commented 8 years ago

I guess this is mergeable, now?

gasche commented 8 years ago

I merged (along with ocaml/ocamlbuild#35 and your MPR#7108 patch. Thanks!

One minor thing: unless you object to it for good reasons, it would be better if your author name also had your family name. I did not pay attention and reused your author name for the upstream ocaml patch, but I regret not including your full name -- other maintainers care about the precision of attribution information.