Add Makefile for easily rebuilding docs

Also includes a neat target for downloading a supported version of docfx easily.
perlun · Mar 25, 2021 · b24e691 · b24e691
1 parent a02489c
commit b24e691
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/.gitignore → .gitignore b/docs/.gitignore → .gitignore
@@ -7,3 +7,6 @@
 /**/bin/
 /**/obj/
 _site
+docfx/*.dll
+docfx/docfx.exe
+docfx/docfx.exe.config
diff --git a/Makefile b/Makefile
@@ -0,0 +1,18 @@
+.PHONY: \
+	all docs
+
+all: docs
+
+docs: docfx/docfx.exe
+	./docfx/docfx.exe docs/docfx.json
+
+# This depends on live-server being available. Install like this (presumed
+# Node.js already being available):
+#
+# npm install -g live-server
+docs-serve:
+	live-server docs/_site
+
+docfx/docfx.exe:
+	wget -qO- https://github.com/dotnet/docfx/releases/download/v2.51/docfx.zip | busybox unzip - -d docfx
+	chmod +x docfx/docfx.exe
diff --git a/docfx/.gitkeep b/docfx/.gitkeep