aboutsummaryrefslogtreecommitdiff
path: root/docs/Makefile
diff options
context:
space:
mode:
authorJ08nY2018-12-08 15:38:14 +0100
committerJ08nY2019-03-14 18:03:59 +0100
commit926e598786197d546a0eae1eeb1d06f341b6cd2e (patch)
tree330c4f8521559b8e34df4137480490bf2eb2feb3 /docs/Makefile
parente0a6e7c452cd55365096bc3e4b8f36f5f9660ae7 (diff)
downloadpyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.tar.gz
pyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.tar.zst
pyecsca-926e598786197d546a0eae1eeb1d06f341b6cd2e.zip
Diffstat (limited to 'docs/Makefile')
-rw-r--r--docs/Makefile24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..a643e8d
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = 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)
+ @echo apidoc -> build api docs
+
+apidoc:
+ mkdir -p api/
+ sphinx-apidoc ../pyecsca/ -o api/
+
+.PHONY: help apidoc Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file