about summary refs log tree commit diff
path: root/tvix/doc
diff options
context:
space:
mode:
authoradisbladis <adisbladis@gmail.com>2021-03-31T18·49+0200
committeradisbladis <adisbladis@gmail.com>2021-03-31T21·51+0000
commit58cca2faaa01af057eafc53fbf3a81b61c88387b (patch)
treeb79cc072c0fd41aea3ce2c8442c287542a5e2a0d /tvix/doc
parent5fa2d39dde33efdc893fff87c7ac9992eeeaf682 (diff)
chore(tvix): Add doc build infrastructure r/2372
Change-Id: I2cf67df085d0c008b5ff5efff2235a670207024a
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2711
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
Reviewed-by: tazjin <mail@tazj.in>
Diffstat (limited to 'tvix/doc')
-rw-r--r--tvix/doc/.gitignore2
-rw-r--r--tvix/doc/Makefile12
-rw-r--r--tvix/doc/default.nix39
3 files changed, 53 insertions, 0 deletions
diff --git a/tvix/doc/.gitignore b/tvix/doc/.gitignore
new file mode 100644
index 000000000000..77699ee8a3f7
--- /dev/null
+++ b/tvix/doc/.gitignore
@@ -0,0 +1,2 @@
+*.svg
+*.html
diff --git a/tvix/doc/Makefile b/tvix/doc/Makefile
new file mode 100644
index 000000000000..ba9e2bdef6d3
--- /dev/null
+++ b/tvix/doc/Makefile
@@ -0,0 +1,12 @@
+all: build
+
+puml:
+	plantuml *.puml -tsvg
+
+html:
+	pandoc *.md -f markdown --self-contained -t html -s -o tvix.html --csl=${CSL}
+
+build: puml html
+
+clean:
+	rm -f *.tex *.pdf *.png *.svg
diff --git a/tvix/doc/default.nix b/tvix/doc/default.nix
new file mode 100644
index 000000000000..606027424a11
--- /dev/null
+++ b/tvix/doc/default.nix
@@ -0,0 +1,39 @@
+{ pkgs, lib, ... }:
+
+let
+
+  tl = pkgs.texlive.combine {
+    inherit (pkgs.texlive) scheme-medium wrapfig ulem capt-of
+    titlesec preprint enumitem paralist ctex environ svg
+    beamer trimspaces zhnumber changepage framed pdfpages
+    fvextra minted upquote ifplatform xstring;
+  };
+
+  csl = pkgs.fetchurl {
+    name = "numeric.csl";
+    url = "https://gist.githubusercontent.com/bwiernik/8c6f39cf51ceb3a03107/raw/1d75c2d62113ffbba6ed03a47ad99bde86934f2b/APA%2520Numeric";
+    sha256 = "1yfhhnhbzvhrv93baz98frmgsx5y442nzhb0l956l4j35fb0cc3h";
+  };
+
+in pkgs.stdenv.mkDerivation {
+  pname = "tvix-doc";
+  version = "0.1";
+
+  src = lib.cleanSource ./.;
+
+  CSL = csl;
+
+  nativeBuildInputs = [
+    pkgs.pandoc
+    pkgs.plantuml
+    tl
+  ];
+
+  installPhase = ''
+    runHook preInstall
+    mkdir -p $out
+    cp -v *.html $out/
+    runHook postSubmit
+  '';
+
+}