From 186c833838776119288fe32282cc59f57faa899b Mon Sep 17 00:00:00 2001
From: sternenseemann <git@lukasepple.de>
Date: Tue, 19 May 2020 01:04:38 +0200
Subject: generate index.html of html docs from mld file

---
 README.md     |  2 +-
 src/dune      |  3 +++
 src/index.mld | 17 +++++++++++++++++
 src/log.mli   |  2 --
 4 files changed, 21 insertions(+), 3 deletions(-)
 create mode 100644 src/index.mld

diff --git a/README.md b/README.md
index ccf1b2f..9edf462 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ private information.
 `logbook` also provides a module `Log` for parsing `log` files and performing
 basic operations on an OCaml representation of a `log` file. It is currently
 mostly useful for reading `log` files and processing its information in some
-way.
+way. For details see the [API documentation](https://sternenseemann.github.io/logbook/doc/logbook/index.html).
 
 `logbook` uses a simplified version of the `log` format, which was originally
 [specified by Profpatsch](https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21).
diff --git a/src/dune b/src/dune
index 1c4a997..63ff388 100644
--- a/src/dune
+++ b/src/dune
@@ -9,3 +9,6 @@
   (public_name logbook)
   (libraries logbook lwt lwt.unix jingoo cow)
   (modules logbook logbook_template logbook_models))
+
+(documentation
+  (mld_files index))
diff --git a/src/index.mld b/src/index.mld
new file mode 100644
index 0000000..d69efff
--- /dev/null
+++ b/src/index.mld
@@ -0,0 +1,17 @@
+{0 logbook}
+
+The [logbook] package includes a command line utility and a OCaml library for dealing with [log] files.
+
+{1 log files}
+
+[log] is a file format for personal diary or log keeping. For detailed information on the
+[log] file format see [man 7 logbook-log] or the [README.md] distributed with this package.
+
+{1 Log}
+
+The {!module-Log} module allows for parsing and manipulation of an OCaml representation of [log] files.
+
+{1 logbook}
+
+For usage information for the [logbook] utility that can generate HTML from [log] files see [man logbook]
+or the [README.md] distributed with this package.
diff --git a/src/log.mli b/src/log.mli
index de92068..116221f 100644
--- a/src/log.mli
+++ b/src/log.mli
@@ -52,8 +52,6 @@ val log_parser : (string log) Angstrom.t
     to apply a specific markup to a freshly parsed log file. *)
 val apply_markup : ('a -> 'b) -> 'a log -> 'b log
 
-(** {2 Log Building} *)
-
 (*---------------------------------------------------------------------------
    Copyright (c) 2017 sternenseemann
 
-- 
cgit 1.4.1