Project

General

Profile

1 5266 jones
# Makefile for Sphinx documentation
2
#
3
4
# You can set these variables from the command line.
5
SPHINXOPTS    =
6 6899 jones
SPHINXBUILD   = `which sphinx-build`
7 5266 jones
PAPER         =
8 6896 jones
BUILDDIR      = ../../../build/docs
9 6899 jones
GRAPHVIZ      = `which dot`
10 5266 jones
11
# Internal variables.
12
PAPEROPT_a4     = -D latex_paper_size=a4
13
PAPEROPT_letter = -D latex_paper_size=letter
14
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
15
16
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest pdf
17
18
help:
19
	@echo "Please use \`make <target>' where <target> is one of"
20
	@echo "  html      to make standalone HTML files"
21
	@echo "  dirhtml   to make HTML files named index.html in directories"
22
	@echo "  pickle    to make pickle files"
23
	@echo "  json      to make JSON files"
24
	@echo "  htmlhelp  to make HTML files and a HTML help project"
25
	@echo "  qthelp    to make HTML files and a qthelp project"
26
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
27
	@echo "  changes   to make an overview of all changed/added/deprecated items"
28
	@echo "  linkcheck to check all external links for integrity"
29
	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
30
	@echo "  pdf       to make PDF files"
31
32
clean:
33
	-rm -rf $(BUILDDIR)/*
34
35
plantuml:
36
	GRAPHVIZ_DOT=$(GRAPHVIZ) plantuml source
37
38
html:
39 6899 jones
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
40 5266 jones
	@echo
41 6899 jones
	@echo "Build finished. The HTML pages are in $(BUILDDIR)."
42 5266 jones
43
dirhtml:
44
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
45
	@echo
46
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
47
48
pickle:
49
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
50
	@echo
51
	@echo "Build finished; now you can process the pickle files."
52
53
json:
54
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
55
	@echo
56
	@echo "Build finished; now you can process the JSON files."
57
58
pdf:
59
	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
60
	@echo
61
	@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."
62
63
htmlhelp:
64
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
65
	@echo
66
	@echo "Build finished; now you can run HTML Help Workshop with the" \
67
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
68
69
qthelp:
70
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
71
	@echo
72
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
73
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
74
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DataONEArchitecture.qhcp"
75
	@echo "To view the help file:"
76
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DataONEArchitecture.qhc"
77
78
latex:
79
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
80
	@echo
81
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
82
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
83
	      "run these through (pdf)latex."
84
85
changes:
86
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
87
	@echo
88
	@echo "The overview file is in $(BUILDDIR)/changes."
89
90
linkcheck:
91
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
92
	@echo
93
	@echo "Link check complete; look for any errors in the above output " \
94
	      "or in $(BUILDDIR)/linkcheck/output.txt."
95
96
doctest:
97
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
98
	@echo "Testing of doctests in the sources finished, look at the " \
99
	      "results in $(BUILDDIR)/doctest/output.txt."