0xffea · aluuu · Jun 4, 2015 · Jun 4, 2015 · Jun 4, 2015 · Jun 4, 2015
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 /*.byte
 /*.native
 /*.docdir
+/.gh-pages
diff --git a/Makefile b/Makefile
@@ -1,8 +1,9 @@
-# OASIS_START
-# DO NOT EDIT (digest: a3c674b4239234cbbe53afe090018954)
-
 SETUP = ocaml setup.ml
 
+DOCDIR = .gh-pages
+DOC_SYNC = $(DOCDIR)/redis.docdir
+DOC_LWT = $(DOCDIR)/redis_lwt.docdir
+
 build: setup.data
 	$(SETUP) -build $(BUILDFLAGS)
 
@@ -36,6 +37,20 @@ setup.data:
 configure:
 	$(SETUP) -configure $(CONFIGUREFLAGS)
 
-.PHONY: build doc test all install uninstall reinstall clean distclean configure
+gh-pages: doc
+	git clone `git config --get remote.origin.url` .gh-pages --reference .
+	git -C .gh-pages checkout --orphan gh-pages
+	git -C .gh-pages reset
+	git -C .gh-pages clean -dxf
+	cp docs/index.html $(DOCDIR)/index.html
+	cp docs/style.css $(DOCDIR)/style.css
+	cp -r _build/src/redis.docdir $(DOC_SYNC)
+	cp -r _build/src/redis_lwt.docdir $(DOC_LWT)
+	cp docs/style.css $(DOC_SYNC)/style.css
+	cp docs/style.css $(DOC_LWT)/style.css
+	git -C .gh-pages add .
+	git -C .gh-pages commit -m "Update Pages"
+	git -C .gh-pages push origin gh-pages -f
+	rm -rf .gh-pages
 
-# OASIS_STOP
+.PHONY: build doc test all install uninstall reinstall clean distclean configure
diff --git a/_oasis b/_oasis
@@ -7,6 +7,7 @@ License:     BSD-3-clause
 Plugins:     META (0.3), DevFiles (0.3)
 BuildTools:  ocamlbuild
 AlphaFeatures: ocamlbuild_more_args
+XDevFilesEnableMakefile: false
 
 Library redis
   Path: src

diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <title>ocaml-redis API documentation</title>
+    <link href="style.css" rel="stylesheet"/>
+  </head>
+  <body>
+    <h1>ocaml-redis API documentation</h1>
+    <ul class="indexlist">
+      <li><a href="redis.docdir/">Synchronous backend</a></li>
+      <li><a href="redis_lwt.docdir/">Lwt backend</a></li>
+    </ul>
+  </body>
+</html>
diff --git a/docs/style.css b/docs/style.css
@@ -0,0 +1,97 @@
+/* A style for ocamldoc. Daniel C. Buenzli */
+
+/* Reset a few things. */
+html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,
+a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,
+small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,
+form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td
+{ margin: 0; padding: 0; border: 0 none; outline: 0; font-size: 100%;
+  font-weight: inherit; font-style:inherit; font-family:inherit;
+  line-height: inherit; vertical-align: baseline; text-align:inherit;
+  color:inherit; background: transparent; }
+
+table { border-collapse: collapse; border-spacing: 0; }
+
+/* Basic page layout */
+
+body { font: normal 10pt/1.375em helvetica, arial, sans-serif; text-align:left;
+       margin: 1.375em 10%; min-width: 40ex; max-width: 72ex;
+       color: black; background: transparent /* url(line-height-22.gif) */; }
+
+b { font-weight: bold }
+em { font-style: italic }
+
+tt, code, pre { font-family: WorkAroundWebKitAndMozilla, monospace;
+                font-size: 1em; }
+pre code { font-size : inherit; }
+.codepre { margin-bottom:1.375em /* after code example we introduce space. */ }
+
+.superscript,.subscript
+{ font-size : 0.813em; line-height:0; margin-left:0.4ex;}
+.superscript { vertical-align: super; }
+.subscript { vertical-align: sub; }
+
+/* ocamldoc markup workaround hacks */
+
+
+
+hr, hr + br, div + br, center + br, span + br, ul + br, ol + br, pre + br
+{ display: none } /* annoying */
+
+div.info + br { display:block}
+
+.codepre br + br { display: none }
+h1 { margin-bottom:1.375em} /* Toplevel module description */
+
+/* Sections and document divisions */
+
+/* .navbar { margin-bottom: -1.375em } */
+h1 { font-weight: bold; font-size: 1.5em; /* margin-top:1.833em; */
+     margin-top:0.917em; padding-top:0.875em;
+     border-top-style:solid; border-width:1px; border-color:#AAA; }
+h2 { font-weight: bold; font-size: 1.313em; margin-top: 1.048em }
+h3 { font-weight: bold; font-size: 1.125em; margin-top: 1.222em }
+h3 { font-weight: bold; font-size: 1em; margin-top: 1.375em}
+h4 { font-style: italic;  }
+
+/* Used by OCaml's own library documentation. */
+ h6 { font-weight: bold; font-size: 1.125em; margin-top: 1.222em }
+ .h7 { font-weight: bold; font-size: 1em; margin-top: 1.375em }
+
+p { margin-top: 1.375em }
+pre { margin-top: 1.375em }
+.info { margin: 0.458em 0em -0.458em 2em;}/* Description of types values etc. */
+td .info { margin:0; padding:0; margin-left: 2em;} /* Description in indexes */
+
+ul, ol { margin-top:0.688em; padding-bottom:0.687em;
+         list-style-position:outside}
+ul + p, ol + p { margin-top: 0em }
+ul { list-style-type: square }
+
+
+/* h2 + ul, h3 + ul, p + ul { } */
+ul > li { margin-left: 1.375em; }
+ol > li { margin-left: 1.7em; }
+/* Links */
+
+a, a:link, a:visited, a:active, a:hover { color : #00B; text-decoration: none }
+a:hover { text-decoration : underline }
+*:target {background-color: #FFFF99;} /* anchor highlight */
+
+/* Code */
+
+.keyword { font-weight: bold; }
+.comment { color : red }
+.constructor { color : green }
+.string { color : brown }
+.warning { color : red ; font-weight : bold }
+
+/* Functors */
+
+.paramstable { border-style : hidden ; padding-bottom:1.375em}
+.paramstable code { margin-left: 1ex; margin-right: 1ex }
+.sig_block {margin-left: 1em}
+
+/* Images */
+
+img { margin-top: 1.375em }
diff --git a/setup.ml b/setup.ml
@@ -1,7 +1,7 @@
 (* setup.ml generated for the first time by OASIS v0.3.1 *)
 
 (* OASIS_START *)
-(* DO NOT EDIT (digest: 9a60dba87a09f90e22c92be6951bbf32) *)
+(* DO NOT EDIT (digest: 5a213d8b42be34430bc34ca5d822ef74) *)
 (*
    Regenerated by OASIS v0.4.5
    Visit http://oasis.forge.ocamlcore.org for more information and
@@ -7284,7 +7284,7 @@ let setup_t =
        };
      oasis_fn = Some "_oasis";
      oasis_version = "0.4.5";
-     oasis_digest = Some "\012��!��\018\129\004Y�h_\000�\020";
+     oasis_digest = Some "�>\1387\n�\130�\031l\146�\023v\138\136";
      oasis_exec = None;
      oasis_setup_args = [];
      setup_update = false

diff --git a/src/cache.mli b/src/cache.mli
@@ -1,3 +1,6 @@
+(**
+   Cache module
+*)
 module Make(IO : S.IO)(Client : S.Client with module IO = IO)(Params : S.Cache_params) : S.Cache
   with module IO = IO
   with module Client = Client

diff --git a/src/client.ml b/src/client.ml
@@ -2,8 +2,6 @@
 
     This has only been tested with Redis 2.2, but will probably work for >= 2.0
  **)
-
-(* Make communication module *)
 module Make(IO : S.IO) = struct
   module IO = IO
 

diff --git a/src/client.mli b/src/client.mli
@@ -1,7 +1,4 @@
-(** Bindings for redis.
-
-    This has only been tested with Redis 2.2, but will probably work for >= 2.0
- **)
-
-(* Make communication module *)
+(**
+   Redis client
+ *)
 module Make(IO : S.IO) : S.Client with module IO = IO
diff --git a/src/mutex.mli b/src/mutex.mli
@@ -1,3 +1,6 @@
+(**
+   Mutex manager
+*)
 module Make(IO : S.IO)(Client : S.Client with module IO = IO) : S.Mutex
   with module IO = IO
   with module Client = Client
diff --git a/src/redis_sync.mli b/src/redis_sync.mli
@@ -1,3 +1,7 @@
+(**
+   Blocking client for Redis
+*)
+
 module IO : S.IO
 
 module Client : S.Client with module IO = IO