add html generation as makefile target

matiaslindgren · matiaslindgren · commit aeca17b50598 · 2020-11-22T00:23:56.000+02:00
diff --git a/Makefile b/Makefile
@@ -1,7 +1,15 @@
 HTML_OUT_DIR := ~/code/py-lidbox.github.io
+EXAMPLE_DIRS := common-voice-small common-voice-augmenting common-voice-embeddings common-voice-angular-lstm
 
-.PHONY: common-voice-small common-voice-large common-voice-augmenting
+.PHONY: $(EXAMPLE_DIRS) index
 
-common-voice-small common-voice-large common-voice-augmenting:
+all: index $(EXAMPLE_DIRS)
+
+$(EXAMPLE_DIRS):
 	@mkdir -pv $(HTML_OUT_DIR)/$@
 	@jupyter nbconvert --to html $@/main.ipynb --stdout > $(HTML_OUT_DIR)/$@/main.html
+	@echo "wrote '$(HTML_OUT_DIR)/$@/main.html'"
+
+index:
+	@python3 md2html.py $(HTML_OUT_DIR)/index.html
+	@echo "wrote '$(HTML_OUT_DIR)/index.html'"
diff --git a/index.md b/index.md
@@ -0,0 +1,8 @@
+# Example notebooks using `lidbox`
+
+| Notebook as HTML | Description |
+|:---------------- |:----------- |
+| [`common-voice-small`](./common-voice-small/main.html) | Classifying 4 languages from the Mozilla Common Voice dataset |
+| [`common-voice-augmenting`](./common-voice-augmenting/main.html) | Repeating example 1 with speech data augmentation |
+| [`common-voice-embeddings`](./common-voice-embeddings/main.html) | Using the trained model from example 2 as a language vector extractor for a back-end classifier |
+| [`common-voice-angular-lstm`](./common-voice-angular-lstm/main.html) | Training a language vector model with a dedicated, angular proximity loss function to maximize distance between vectors from different languages |
diff --git a/index.template.html b/index.template.html
@@ -0,0 +1,14 @@
+<!DOCTYPE HTML>
+<html lang="en">
+
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>lidbox examples</title>
+  </head>
+
+  <body>
+    $body
+  </body>
+
+</html>
diff --git a/md2html.py b/md2html.py
@@ -0,0 +1,24 @@
+import argparse
+import string
+
+import mistune
+
+
+def readf(path):
+    with open(path) as f:
+        return f.read()
+
+
+def main(outpath, template="./index.template.html", md_body="./index.md"):
+    html_body = mistune.markdown(readf(md_body))
+    html_full = string.Template(readf(template)).substitute(body=html_body)
+    with open(outpath, "w") as out_f:
+        print(html_full, file=out_f)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("outpath")
+
+    args = parser.parse_args()
+    main(args.outpath)
