Revision eb4ed8c6 docs/Makefile

b/docs/Makefile
4 4
# You can set these variables from the command line.
5 5
SPHINXOPTS    =
6 6
SPHINXBUILD   = sphinx-build
7
EPYBUILD	  = epydoc
8
EPYCONFLOC	  = source
9
APIDIR		  = api
10

  
7 11
PAPER         =
8 12
BUILDDIR      = build
9 13

  
14

  
10 15
# Internal variables.
11 16
PAPEROPT_a4     = -D latex_paper_size=a4
12 17
PAPEROPT_letter = -D latex_paper_size=letter
......
16 21

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

  
24
	@echo "  html      to make standalone sphinx HTML files"
25
	@echo "  api      to make standalone epydoc API files"
26
	
30 27
clean:
31 28
	-rm -rf $(BUILDDIR)/*
32 29

  
......
35 32
	@echo
36 33
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
37 34

  
38
dirhtml:
39
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
40
	@echo
41
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
42

  
43
pickle:
44
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
45
	@echo
46
	@echo "Build finished; now you can process the pickle files."
47

  
48
json:
49
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
50
	@echo
51
	@echo "Build finished; now you can process the JSON files."
52

  
53
htmlhelp:
54
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
55
	@echo
56
	@echo "Build finished; now you can run HTML Help Workshop with the" \
57
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
58

  
59
qthelp:
60
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
61
	@echo
62
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
63
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ncclient.qhcp"
65
	@echo "To view the help file:"
66
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ncclient.qhc"
67

  
68
latex:
69
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
70
	@echo
71
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
72
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
73
	      "run these through (pdf)latex."
74

  
75
changes:
76
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
35
api:
36
	@mkdir -p $(BUILDDIR)/$(APIDIR)
37
	$(EPYBUILD) -v -c $(EPYCONFLOC)/epydoc.conf --exclude migrations -o $(BUILDDIR)/$(APIDIR) iooclient
77 38
	@echo
78
	@echo "The overview file is in $(BUILDDIR)/changes."
39
	@echo "Build finished. The API pages are in $(BUILDDIR)/$(APIDIR)"
79 40

  
80
linkcheck:
81
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
82
	@echo
83
	@echo "Link check complete; look for any errors in the above output " \
84
	      "or in $(BUILDDIR)/linkcheck/output.txt."
85 41

  
86
doctest:
87
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
88
	@echo "Testing of doctests in the sources finished, look at the " \
89
	      "results in $(BUILDDIR)/doctest/output.txt."

Also available in: Unified diff