about summary refs log tree commit diff
path: root/pkgs/development/ocaml-modules/odig
diff options
context:
space:
mode:
authorJules Aguillon <jules@j3s.fr>2023-07-04 15:57:37 +0200
committerJules Aguillon <jules@j3s.fr>2023-09-28 12:03:20 +0200
commitb94953dbd41c3e6e371a9ba2fe97e7c7750b92a8 (patch)
tree1f118237f72a64451e32e784d7f31ed293f9f36a /pkgs/development/ocaml-modules/odig
parent187d777aada735b5793f78b9b62726ce0752d739 (diff)
odig: Init at 0.0.9
Odig is a tool for building the documentation of OCaml libraries. It is
described with the recent `buildTopkgPackage` function.
Diffstat (limited to 'pkgs/development/ocaml-modules/odig')
-rw-r--r--pkgs/development/ocaml-modules/odig/default.nix25
1 files changed, 25 insertions, 0 deletions
diff --git a/pkgs/development/ocaml-modules/odig/default.nix b/pkgs/development/ocaml-modules/odig/default.nix
new file mode 100644
index 0000000000000..5ea3730c7ff4c
--- /dev/null
+++ b/pkgs/development/ocaml-modules/odig/default.nix
@@ -0,0 +1,25 @@
+{ lib, stdenv, fetchurl, buildTopkgPackage, cmdliner, odoc, b0 }:
+
+buildTopkgPackage rec {
+  pname = "odig";
+  version = "0.0.9";
+
+  src = fetchurl {
+    url = "${meta.homepage}/releases/odig-${version}.tbz";
+    sha256 = "sha256-sYKvGYkxeF5FmrNQdOyMAtlsJqhlmUESi9SkPn/cjM4=";
+  };
+
+  buildInputs = [ cmdliner odoc b0 ];
+
+  meta = with lib; {
+    description = "Lookup documentation of installed OCaml packages";
+    longDescription = ''
+      odig is a command line tool to lookup documentation of installed OCaml
+      packages. It shows package metadata, readmes, change logs, licenses,
+      cross-referenced `odoc` API documentation and manuals.
+    '';
+    homepage = "https://erratique.ch/software/odig";
+    license = licenses.isc;
+    maintainers = [ maintainers.Julow ];
+  };
+}