summaryrefslogtreecommitdiffstats
path: root/comm/docs/Makefile
diff options
context:
space:
mode:
Diffstat (limited to 'comm/docs/Makefile')
-rw-r--r--comm/docs/Makefile32
1 files changed, 32 insertions, 0 deletions
diff --git a/comm/docs/Makefile b/comm/docs/Makefile
new file mode 100644
index 0000000000..a9bc6a02c3
--- /dev/null
+++ b/comm/docs/Makefile
@@ -0,0 +1,32 @@
+# Minimal makefile for Sphinx documentation
+#
+
+VENV = _venv
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= ./$(VENV)/bin/sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+venv: Makefile
+ python -m venv --upgrade-deps $(VENV)
+ ./$(VENV)/bin/pip install -r requirements.txt
+
+
+clean:
+ @rm -rf $(VENV) $(BUILDDIR)
+
+
+.PHONY: help Makefile $(SPHINXBUILD)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: $(SPHINXBUILD)
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)