made doc generation marginally easier

sigpwny · Mar 4, 2024 · 4f79428 · 4f79428
1 parent cc8fe70
commit 4f79428
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/docs/dependencies.sh b/docs/dependencies.sh
@@ -0,0 +1,2 @@
+sudo npm install -g [email protected]
+sudo npm install --global mermaid-filter
diff --git a/docs/make_doc.sh b/docs/make_doc.sh
@@ -0,0 +1 @@
+pandoc --number-sections hide_protocol.md misc_protocol.md flash.md -F mermaid-filter -o UIUC_Documentation.pdf --pdf-engine=tectonic
diff --git a/docs/run_once.sh b/docs/run_once.sh
@@ -0,0 +1,4 @@
+chmod +x dependencies.sh
+chmod +x make_doc.sh
+nix-shell shell.nix
+./dependencies.sh
diff --git a/docs/shell.nix b/docs/shell.nix
@@ -0,0 +1,11 @@
+# shell.nix
+
+{ pkgs ? import <nixpkgs> {} }:
+
+pkgs.mkShell {
+  buildInputs = [
+    pkgs.pandoc
+    pkgs.nodejs
+    pkgs.tectonic
+  ];
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		sudo npm install -g [email protected]
		sudo npm install --global mermaid-filter
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		pandoc --number-sections hide_protocol.md misc_protocol.md flash.md -F mermaid-filter -o UIUC_Documentation.pdf --pdf-engine=tectonic