Ich möchte Quellcode in meine generierten Dokumente einfügen. Das funktioniert, wenn ich ocamldoc in der Befehlszeile wie folgt aufrufen: ocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir . Ich habe jedoch Probleme mit der Integration von ocamlbuild .
Ich verwende den folgenden Code in myocamlbuild.ml :
Aber das schließt nur die Quelle für Dateien ohne entsprechende Schnittstellendatei ein - im Gegensatz zu dem, was gesagt wird Hier sieht es so aus, als ob ocamlbuild es ablehnt, .ml -Dateien an ocamldoc zu übergeben, wenn eine .mli -Datei vorhanden ist. Gibt es eine Möglichkeit, ocamlbuild dazu zu bringen, das zu tun, was ich will?
Da ich etwas hacken musste, um etwas ähnliches zu tun, würde es vielleicht helfen, wenn ich es hier als Antwort poste (zumindest bis OCamlbuild das bietet). Also, hier ist der relevante Teil meiner myocamlbuild.ml :
Das Hinzufügen des Tags doc_use_interf_n_implem zu .ml und / oder .mli -Dateien, für die die Dokumentation sowohl von der Implementierung als auch von der Schnittstelle generiert werden soll, sollte den Zweck erfüllen.
Mit dem obigen Code kann das Hinzufügen von Zusammenführungsoptionen auch durch Hinzufügen von Tags wie zum Beispiel merge(A) (zum Zusammenführen aller) erfolgen.
Beachten Sie, dass dies ein Hack ist, der die Inhalte in komplexen Projekten beschädigen kann. Bemerkenswerterweise habe ich es nicht mit camlp[45] -verarbeiteten Dateien getestet, noch mit OCamlbuild-Versionen anders als 4.00.1.
Es scheint, dass es in OCamlbuild derzeit keine Unterstützung dafür gibt. Könnten Sie bitte eine Feature-Anfrage für diese auf dem Bugtracker einreichen?
Tags und Links ocaml ocamlbuild ocamldoc