/
Makefile
49 lines (39 loc) · 1.48 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# Makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# this is to to autmagic gh-pages
GH_PAGES_SOURCES = docs qcodes CONTRIBUTING.rst LICENSE
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile clean genapi htmlfast
clean:
rm -rf $(BUILDDIR)/*
rm -rf _auto
rm -rf api/generated
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# generate api docs for instruments automatically
genapi:
sphinx-apidoc -o _auto -d 10 ../qcodes \
../qcodes/instrument_drivers/keysight \
../qcodes/instrument_drivers/QuantumDesign/DynaCoolPPMS/private/*
mkdir -p api/generated/
cp _auto/qcodes.instrument_drivers.* api/generated/
# faster build by skipping execution of all notebooks
htmlfast: genapi
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -D nbsphinx_execute=never
# this is only left for backwards compatibility.
.PHONY: html-api
html-api: html
# this is only left for backwards compatibility.
.PHONY: htmlapi
htmlapi: html
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile genapi
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)