← Back to branch summary

~ubuntu-branches/ubuntu/quantal/nova/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/Makefile

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-08-16 14:04:11 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20120816140411-0mr4n241wmk30t9l
Tags: upstream-2012.2~f3
Import upstream version 2012.2~f3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Makefile
1
 
# Makefile for Sphinx documentation
2
 
#
3
 
 
4
 
# You can set these variables from the command line.
5
 
SPHINXOPTS    =
6
 
SPHINXBUILD   = sphinx-build
7
 
SPHINXSOURCE    = source
8
 
PAPER         =
9
 
BUILDDIR      = build
10
 
 
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) $(SPHINXSOURCE)
15
 
 
16
 
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
17
 
 
18
 
.DEFAULT_GOAL   = html
19
 
 
20
 
help:
21
 
        @echo "Please use \`make <target>' where <target> is one of"
22
 
        @echo "  html      to make standalone HTML files"
23
 
        @echo "  dirhtml   to make HTML files named index.html in directories"
24
 
        @echo "  pickle    to make pickle files"
25
 
        @echo "  json      to make JSON files"
26
 
        @echo "  htmlhelp  to make HTML files and a HTML help project"
27
 
        @echo "  qthelp    to make HTML files and a qthelp project"
28
 
        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
 
        @echo "  changes   to make an overview of all changed/added/deprecated items"
30
 
        @echo "  linkcheck to check all external links for integrity"
31
 
        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
32
 
 
33
 
clean:
34
 
        -rm -rf $(BUILDDIR)/*
35
 
        -rm -rf nova.sqlite
36
 
        if [ -f .autogenerated ] ; then \
37
 
        cat .autogenerated | xargs rm ; \
38
 
        rm .autogenerated ; \
39
 
    fi
40
 
 
41
 
html:
42
 
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
43
 
        @echo
44
 
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
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
 
htmlhelp:
62
 
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
63
 
        @echo
64
 
        @echo "Build finished; now you can run HTML Help Workshop with the" \
65
 
              ".hhp project file in $(BUILDDIR)/htmlhelp."
66
 
 
67
 
qthelp:
68
 
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
69
 
        @echo
70
 
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
71
 
              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
72
 
        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nova.qhcp"
73
 
        @echo "To view the help file:"
74
 
        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
75
 
 
76
 
latex:
77
 
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
78
 
        @echo
79
 
        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
80
 
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
81
 
              "run these through (pdf)latex."
82
 
 
83
 
changes:
84
 
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
85
 
        @echo
86
 
        @echo "The overview file is in $(BUILDDIR)/changes."
87
 
 
88
 
linkcheck:
89
 
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
90
 
        @echo
91
 
        @echo "Link check complete; look for any errors in the above output " \
92
 
              "or in $(BUILDDIR)/linkcheck/output.txt."
93
 
 
94
 
doctest:
95
 
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
96
 
        @echo "Testing of doctests in the sources finished, look at the " \
97
 
              "results in $(BUILDDIR)/doctest/output.txt."