Project

General

Profile

metacat / docs / user / metacat / Makefile @ 8587

1
# Makefile for Sphinx documentation
2
#
3

    
4
# You can set these variables from the command line.
5
SPHINXOPTS    =
6
SPHINXBUILD   = `which sphinx-build`
7
PAPER         =
8
BUILDDIR      = ../../../build/docs
9
GRAPHVIZ      = `which dot`
10
JAVA          = `which java`
11
PLANTUMLCONF  = $(CURDIR)/../../tools/plantuml.conf
12
PLANTUML      = $(JAVA) -jar "$(CURDIR)/../../tools/plantuml.jar" -config "$(PLANTUMLCONF)"
13

    
14
# Internal variables.
15
PAPEROPT_a4     = -D latex_paper_size=a4
16
PAPEROPT_letter = -D latex_paper_size=letter
17
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
18

    
19
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest pdf
20

    
21
help:
22
	@echo "Please use \`make <target>' where <target> is one of"
23
	@echo "  html      to make standalone HTML files"
24
	@echo "  dirhtml   to make HTML files named index.html in directories"
25
	@echo "  pickle    to make pickle files"
26
	@echo "  json      to make JSON files"
27
	@echo "  htmlhelp  to make HTML files and a HTML help project"
28
	@echo "  qthelp    to make HTML files and a qthelp project"
29
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
30
	@echo "  changes   to make an overview of all changed/added/deprecated items"
31
	@echo "  linkcheck to check all external links for integrity"
32
	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
33
	@echo "  pdf       to make PDF files"
34

    
35
clean:
36
	-rm -rf $(BUILDDIR)/*
37

    
38
plantuml:
39
	GRAPHVIZ_DOT=$(GRAPHVIZ) $(PLANTUML) "$(CURDIR)/source/*.rst"
40

    
41
html: 
42
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
43
	@echo
44
	@echo "Build finished. The HTML pages are in $(BUILDDIR)."
45

    
46
dirhtml:
47
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
48
	@echo
49
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
50

    
51
pickle:
52
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
53
	@echo
54
	@echo "Build finished; now you can process the pickle files."
55

    
56
json:
57
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
58
	@echo
59
	@echo "Build finished; now you can process the JSON files."
60

    
61
pdf:
62
	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
63
	@echo
64
	@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."
65

    
66
htmlhelp:
67
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
68
	@echo
69
	@echo "Build finished; now you can run HTML Help Workshop with the" \
70
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
71

    
72
qthelp:
73
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
74
	@echo
75
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
76
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
77
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DataONEArchitecture.qhcp"
78
	@echo "To view the help file:"
79
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DataONEArchitecture.qhc"
80

    
81
latex:
82
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
83
	@echo
84
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
85
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
86
	      "run these through (pdf)latex."
87

    
88
changes:
89
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
90
	@echo
91
	@echo "The overview file is in $(BUILDDIR)/changes."
92

    
93
linkcheck:
94
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
95
	@echo
96
	@echo "Link check complete; look for any errors in the above output " \
97
	      "or in $(BUILDDIR)/linkcheck/output.txt."
98

    
99
doctest:
100
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
101
	@echo "Testing of doctests in the sources finished, look at the " \
102
	      "results in $(BUILDDIR)/doctest/output.txt."