Merge pull request mirage#94 from djs55/fix-docs

Fix generation of the docs
avsm · Mar 12, 2016 · 3d2722c · 3d2722c
2 parents 6a2070b + 34f4146
commit 3d2722c
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 17 deletions.
diff --git a/_oasis b/_oasis
@@ -109,10 +109,26 @@ Test misc_tests
   Run:              true
   WorkingDirectory: _build/lib/
 
-Document api
+Document cstruct
   Title:              Documentation and API reference
   Type:               ocamlbuild (0.3)
   BuildTools+:        ocamldoc
-  XOcamlbuildPath:    doc
-  XOcamlbuildModules: Cstruct, Lwt_cstruct, Unix_cstruct
+  XOcamlbuildPath:    lib
+  XOcamlbuildModules: Cstruct
+  Install:            false
+
+Document cstruct_lwt
+  Title:              Documentation and Lwt API reference
+  Type:               ocamlbuild (0.3)
+  BuildTools+:        ocamldoc
+  XOcamlbuildPath:    lwt
+  XOcamlbuildModules: Lwt_cstruct
+  Install:            false
+
+Document cstruct_unix
+  Title:              Documentation and Unix API reference
+  Type:               ocamlbuild (0.3)
+  BuildTools+:        ocamldoc
+  XOcamlbuildPath:    unix
+  XOcamlbuildModules: Unix_cstruct
   Install:            false
diff --git a/doc/api.odocl b/doc/api.odocl
diff --git a/lib/cstruct.odocl b/lib/cstruct.odocl
@@ -0,0 +1,4 @@
+# OASIS_START
+# DO NOT EDIT (digest: 1e0fe6af05a6e3ed01c123c49f04dcbb)
+Cstruct
+# OASIS_STOP
diff --git a/lwt/cstruct_lwt.odocl b/lwt/cstruct_lwt.odocl
@@ -0,0 +1,4 @@
+# OASIS_START
+# DO NOT EDIT (digest: d1391b5d2c30f723aff19f224fcc3c16)
+Lwt_cstruct
+# OASIS_STOP
diff --git a/setup.ml b/setup.ml
@@ -1,7 +1,7 @@
 (* setup.ml generated for the first time by OASIS v0.4.5 *)
 
 (* OASIS_START *)
-(* DO NOT EDIT (digest: eecd3267f843d483f00ca09495b957b7) *)
+(* DO NOT EDIT (digest: fc87cc3dbfcd77f09d9ff62fcd56b88b) *)
 (*
    Regenerated by OASIS v0.4.5
    Visit http://oasis.forge.ocamlcore.org for more information and
@@ -6824,9 +6824,15 @@ let setup_t =
        ];
      doc =
        [
-          ("api",
+          ("cstruct",
             OCamlbuildDocPlugin.doc_build
-              {OCamlbuildDocPlugin.extra_args = []; run_path = "doc"})
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "lib"});
+          ("cstruct_lwt",
+            OCamlbuildDocPlugin.doc_build
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "lwt"});
+          ("cstruct_unix",
+            OCamlbuildDocPlugin.doc_build
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "unix"})
        ];
      install = InternalInstallPlugin.install;
      uninstall = InternalInstallPlugin.uninstall;
@@ -6852,9 +6858,15 @@ let setup_t =
        ];
      clean_doc =
        [
-          ("api",
+          ("cstruct",
+            OCamlbuildDocPlugin.doc_clean
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "lib"});
+          ("cstruct_lwt",
+            OCamlbuildDocPlugin.doc_clean
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "lwt"});
+          ("cstruct_unix",
             OCamlbuildDocPlugin.doc_clean
-              {OCamlbuildDocPlugin.extra_args = []; run_path = "doc"})
+              {OCamlbuildDocPlugin.extra_args = []; run_path = "unix"})
        ];
      distclean = [];
      distclean_test =
@@ -7338,7 +7350,7 @@ let setup_t =
                    });
                Doc
                  ({
-                     cs_name = "api";
+                     cs_name = "cstruct";
                      cs_data = PropList.Data.create ();
                      cs_plugin_data = []
                   },
@@ -7363,6 +7375,62 @@ let setup_t =
                       doc_data_files = [];
                       doc_build_tools =
                         [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"]
+                   });
+               Doc
+                 ({
+                     cs_name = "cstruct_lwt";
+                     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 Lwt API reference";
+                      doc_authors = [];
+                      doc_abstract = None;
+                      doc_format = OtherDoc;
+                      doc_data_files = [];
+                      doc_build_tools =
+                        [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"]
+                   });
+               Doc
+                 ({
+                     cs_name = "cstruct_unix";
+                     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 Unix API reference";
+                      doc_authors = [];
+                      doc_abstract = None;
+                      doc_format = OtherDoc;
+                      doc_data_files = [];
+                      doc_build_tools =
+                        [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"]
                    })
             ];
           plugins =
@@ -7373,14 +7441,14 @@ let setup_t =
        };
      oasis_fn = Some "_oasis";
      oasis_version = "0.4.5";
-     oasis_digest = Some "^?Dë¹JtJºì\007ËJüL\026";
+     oasis_digest = Some "p\140º\156\021\\\019\026Ê¾\031ËhÂ\006\026";
      oasis_exec = None;
      oasis_setup_args = [];
      setup_update = false
   };;
 
 let setup () = BaseSetup.setup setup_t;;
 
-# 7385 "setup.ml"
+# 7453 "setup.ml"
 (* OASIS_STOP *)
 let () = setup ();;
diff --git a/unix/cstruct_unix.odocl b/unix/cstruct_unix.odocl
@@ -0,0 +1,4 @@
+# OASIS_START
+# DO NOT EDIT (digest: 95a77fdaf3824610874360801bd4a05c)
+Unix_cstruct
+# OASIS_STOP