Add Makefile modified for sphinx

[nmutil.git] / Makefile

diff --git a/Makefile b/Makefile
index 0e4eb514e75a256257f89ad7ff4c46f7614987ba..5a57e588ca9544876fb939650da90d0087a1c494 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,7 @@
 PYTHON3 ?= "python3"
 
+.PHONY: help Makefile install test htmlupload
+
 install:
        $(PYTHON3) setup.py develop # yes, develop, not install
 
@@ -8,3 +10,30 @@ test:
 
 pypiupload:
        $(PYTHON3) setup.py sdist upload
+
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = nmutil
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+       @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# copies all documentation to libre-soc (libre-soc admins only)
+htmlupload: clean html
+       rsync -HPavz --delete build/html/* \
+        libre-soc.org:/var/www/libre-soc.org/docs/nmutil/
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+       echo "catch-all falling through to sphinx for document building"
+       mkdir -p "$(SOURCEDIR)"/src/gen
+       sphinx-apidoc --ext-autodoc -o "$(SOURCEDIR)"/src/gen ./src/nmutil
+       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)