Skip to content

Commit

Permalink
Documentation generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vincent Bernardoff committed Aug 5, 2013
1 parent 29436c7 commit 2851a1f
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ _build/
*.bin
setup.data
setup.log

*.docdir
8 changes: 8 additions & 0 deletions _oasis
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,11 @@ Test lwt_test
Run$: flag(tests)
Command: $lwt_test
WorkingDirectory: lwt_test

Document api
Title: Documentation and API reference
Type: ocamlbuild (0.3)
BuildTools+: ocamldoc
XOCamlbuildModules: Ring, Lwt_ring
XOcamlbuildPath: doc
Install: false
4 changes: 3 additions & 1 deletion _tags
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@
<examples/client.{native,byte}>: custom
# OASIS_STOP
true: annot
<*/*>: syntax_camlp4o
<*/*.ml{,i}>: syntax_camlp4o
<lib/ring>: pkg_cstruct.syntax
<lwt/lwt_ring>: pkg_lwt.syntax
<lwt_test/lwt_test>: pkg_lwt.syntax
<lib>: include
<lwt>: include
5 changes: 5 additions & 0 deletions doc/api.odocl
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# OASIS_START
# DO NOT EDIT (digest: 66e319937b5e8e7ea685a7d255805dc1)
Ring
Lwt_ring
# OASIS_STOP
39 changes: 33 additions & 6 deletions setup.ml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(* setup.ml generated for the first time by OASIS v0.3.0 *)

(* OASIS_START *)
(* DO NOT EDIT (digest: b41907c119957f3040dd60253136c05a) *)
(* DO NOT EDIT (digest: d0f25f884bbe4ee6d5c797163aca7574) *)
(*
Regenerated by OASIS v0.3.0
Visit http://oasis.forge.ocamlcore.org for more information and
Expand Down Expand Up @@ -5717,7 +5717,7 @@ let setup_t =
cmd_distclean = [(OASISExpr.EBool true, None)];
})
];
doc = [];
doc = [("api", OCamlbuildDocPlugin.doc_build "doc")];
install = InternalInstallPlugin.install;
uninstall = InternalInstallPlugin.uninstall;
clean = [OCamlbuildPlugin.clean];
Expand All @@ -5740,7 +5740,7 @@ let setup_t =
cmd_distclean = [(OASISExpr.EBool true, None)];
})
];
clean_doc = [];
clean_doc = [("api", OCamlbuildDocPlugin.doc_clean "doc")];
distclean = [];
distclean_test =
[
Expand Down Expand Up @@ -6115,6 +6115,34 @@ let setup_t =
true)
];
test_tools = [ExternalTool "ocamlbuild"];
});
Doc
({
cs_name = "api";
cs_data = PropList.Data.create ();
cs_plugin_data = [];
},
{
doc_type = (`Doc, "ocamlbuild", Some "0.3");
doc_custom =
{
pre_command = [(OASISExpr.EBool true, None)];
post_command = [(OASISExpr.EBool true, None)];
};
doc_build =
[
(OASISExpr.ENot (OASISExpr.EFlag "docs"), false);
(OASISExpr.EFlag "docs", true)
];
doc_install = [(OASISExpr.EBool true, false)];
doc_install_dir = "$docdir";
doc_title = "Documentation and API reference";
doc_authors = [];
doc_abstract = None;
doc_format = OtherDoc;
doc_data_files = [];
doc_build_tools =
[ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"];
})
];
plugins = [(`Extra, "META", Some "0.3")];
Expand All @@ -6123,15 +6151,14 @@ let setup_t =
};
oasis_fn = Some "_oasis";
oasis_version = "0.3.0";
oasis_digest =
Some "\169\209\015\148\157\167\149\254\212}\1480\011\148\193z";
oasis_digest = Some "n\161\r_\165/\141\149\214\187*\217Q\190\135\024";
oasis_exec = None;
oasis_setup_args = [];
setup_update = false;
};;

let setup () = BaseSetup.setup setup_t;;

# 6136 "setup.ml"
# 6163 "setup.ml"
(* OASIS_STOP *)
let () = setup ();;

0 comments on commit 2851a1f

Please sign in to comment.