From bafee555d37023068e1ebda0ca61432b662ea6ac Mon Sep 17 00:00:00 2001 From: Drup Date: Sat, 13 Dec 2014 02:48:03 +0100 Subject: [PATCH] Stub for intro documentation. --- _oasis | 40 +++++++--------------------------------- doc/intro.txt | 0 myocamlbuild.ml | 12 +++++++++++- 3 files changed, 18 insertions(+), 34 deletions(-) create mode 100644 doc/intro.txt diff --git a/_oasis b/_oasis index 6386f2b3..c1c020be 100644 --- a/_oasis +++ b/_oasis @@ -8,7 +8,7 @@ LicenseFile: LICENSE Plugins: META (0.3), DevFiles (0.3) OCamlVersion: >= 4.00.1 BuildTools: ocamlbuild -AlphaFeatures: compiled_setup_ml +AlphaFeatures: compiled_setup_ml, ocamlbuild_more_args Synopsis: A modular standard library focused on data structures. Description: @@ -144,39 +144,13 @@ Document containers BuildTools+: ocamldoc Install: true XOCamlbuildPath: . - XOCamlbuildLibraries: containers,containers.string + XOCamlbuildExtraArgs: + "-docflags '-colorize-code -short-functors -charset utf-8'" + XOCamlbuildLibraries: + containers, containers.misc, + containers.string, containers.advanced, + containers.lwt -Document containers_misc - Title: Containers_misc docs - Type: ocamlbuild (0.3) - BuildTools+: ocamldoc - Install: true - XOCamlbuildPath: . - XOCamlbuildLibraries: containers.misc - -Document containers_string - Title: Containers_string docs - Type: ocamlbuild (0.3) - BuildTools+: ocamldoc - Install: true - XOCamlbuildPath: . - XOCamlbuildLibraries: containers.string - -Document containers_advanced - Title: Containers_advanced docs - Type: ocamlbuild (0.3) - BuildTools+: ocamldoc - Install: true - XOCamlbuildPath: . - XOCamlbuildLibraries: containers.advanced - -Document containers_lwt - Title: Containers_lwt docs - Type: ocamlbuild (0.3) - BuildTools+: ocamldoc - Install: true - XOCamlbuildPath: . - XOCamlbuildLibraries: containers.lwt Executable run_benchs Path: benchs/ diff --git a/doc/intro.txt b/doc/intro.txt new file mode 100644 index 00000000..e69de29b diff --git a/myocamlbuild.ml b/myocamlbuild.ml index 06976423..8686ebd8 100644 --- a/myocamlbuild.ml +++ b/myocamlbuild.ml @@ -1,6 +1,8 @@ (* OASIS_START *) (* OASIS_STOP *) +let doc_intro = "doc/intro.txt" + open Ocamlbuild_plugin;; dispatch @@ -40,7 +42,15 @@ dispatch let ocaml_major = "OCAML_MAJOR " ^ string_of_int major in let ocaml_minor = "OCAML_MINOR " ^ string_of_int minor in - flag ["cppo"] & S[A"-D"; A ocaml_major; A"-D"; A ocaml_minor] + flag ["cppo"] & S[A"-D"; A ocaml_major; A"-D"; A ocaml_minor] ; + + (* Documentation index *) + dep ["ocaml"; "doc"; "extension:html"] & [doc_intro] ; + flag ["ocaml"; "doc"; "extension:html"] & + (S[A"-t"; A"LILiS user guide"; + A"-intro"; P doc_intro; + ]); + | _ -> () end; dispatch_default