← Back to branch summary

~openstack-gd/nova/lp785816-joinedload

« back to all changes in this revision

Viewing changes to doc/source/Makefile

  • Committer: Todd Willey
  • Date: 2010-11-07 19:51:40 UTC
  • mto: (386.2.41 trunkdoc)
  • mto: This revision was merged to the branch mainline in revision 398.
  • Revision ID: todd@ansolabs.com-20101107195140-djbg5mkmbz0jc03w
Merge lp:~termie/nova/trunkdoc (via patch, since bzr though it was already merged)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/Makefile
4
4
# You can set these variables from the command line.
5
5
SPHINXOPTS    =
6
6
SPHINXBUILD   = sphinx-build
 
7
SPHINXSOURCE    = source
7
8
PAPER         =
8
 
BUILDDIR      = _build
 
9
BUILDDIR      = build
9
10
 
10
11
# Internal variables.
11
12
PAPEROPT_a4     = -D latex_paper_size=a4
12
13
PAPEROPT_letter = -D latex_paper_size=letter
13
 
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
14
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSOURCE)
14
15
 
15
16
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16
17
 
 
18
.DEFAULT_GOAL   = html
 
19
 
17
20
help:
18
21
        @echo "Please use \`make <target>' where <target> is one of"
19
22
        @echo "  html      to make standalone HTML files"
29
32
 
30
33
clean:
31
34
        -rm -rf $(BUILDDIR)/*
32
 
 
33
 
html:
 
35
        -rm -rf nova.sqlite
 
36
        cat .autogenerated | xargs rm 
 
37
        rm .autogenerated
 
38
 
 
39
module_autodoc: generate_autodoc_index.sh
 
40
        @echo "Generating module autodocs."
 
41
        ./generate_autodoc_index.sh
 
42
 
 
43
source/code.rst: module_autodoc
 
44
        @# pass
 
45
 
 
46
html: source/code.rst
34
47
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
35
48
        @echo
36
49
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
37
50
 
38
 
dirhtml:
 
51
dirhtml: source/code.rst
39
52
        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
40
53
        @echo
41
54
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
42
55
 
43
 
pickle:
 
56
pickle: source/code.rst
44
57
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
45
58
        @echo
46
59
        @echo "Build finished; now you can process the pickle files."
47
60
 
48
 
json:
 
61
json: source/code.rst
49
62
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
50
63
        @echo
51
64
        @echo "Build finished; now you can process the JSON files."
52
65
 
53
 
htmlhelp:
 
66
htmlhelp: source/code.rst
54
67
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
55
68
        @echo
56
69
        @echo "Build finished; now you can run HTML Help Workshop with the" \
57
70
              ".hhp project file in $(BUILDDIR)/htmlhelp."
58
71
 
59
 
qthelp:
 
72
qthelp: source/code.rst
60
73
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
61
74
        @echo
62
75
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
65
78
        @echo "To view the help file:"
66
79
        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc"
67
80
 
68
 
latex:
 
81
latex: source/code.rst
69
82
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
70
83
        @echo
71
84
        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
72
85
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
73
86
              "run these through (pdf)latex."
74
87
 
75
 
changes:
 
88
changes: source/code.rst
76
89
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
77
90
        @echo
78
91
        @echo "The overview file is in $(BUILDDIR)/changes."
79
92
 
80
 
linkcheck:
 
93
linkcheck: source/code.rst
81
94
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
82
95
        @echo
83
96
        @echo "Link check complete; look for any errors in the above output " \
84
97
              "or in $(BUILDDIR)/linkcheck/output.txt."
85
98
 
86
 
doctest:
 
99
doctest: source/code.rst
87
100
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
88
101
        @echo "Testing of doctests in the sources finished, look at the " \
89
102
              "results in $(BUILDDIR)/doctest/output.txt."