##// END OF EJS Templates
update help to include html_noapi target
Paul Ivanov -
Show More
@@ -1,140 +1,141
1 1 # Makefile for Sphinx documentation
2 2 #
3 3
4 4 # You can set these variables from the command line.
5 5 SPHINXOPTS =
6 6 SPHINXBUILD = sphinx-build
7 7 PAPER =
8 8 SRCDIR = source
9 9 BUILDDIR = build
10 10
11 11 # Internal variables.
12 12 PAPEROPT_a4 = -D latex_paper_size=a4
13 13 PAPEROPT_letter = -D latex_paper_size=letter
14 14 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
15 15
16 16 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
17 17
18 18 default: html
19 19
20 20 help:
21 21 @echo "Please use \`make <target>' where <target> is one of"
22 @echo " html to make standalone HTML files"
23 @echo " pickle to make pickle files (usable by e.g. sphinx-web)"
24 @echo " htmlhelp to make HTML files and a HTML help project"
25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26 @echo " texinfo to make Texinfo files"
27 @echo " info to make Texinfo files and run them through makeinfo"
28 @echo " changes to make an overview over all changed/added/deprecated items"
29 @echo " linkcheck to check all external links for integrity"
22 @echo " html standalone HTML files"
23 @echo " html_noapi same as above, without the time consuming API docs"
24 @echo " pickle pickle files (usable by e.g. sphinx-web)"
25 @echo " htmlhelp HTML files and a HTML help project"
26 @echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter"
27 @echo " texinfo Texinfo files"
28 @echo " info Texinfo files and run them through makeinfo"
29 @echo " changes an overview over all changed/added/deprecated items"
30 @echo " linkcheck check all external links for integrity (takes a long time)"
30 31 @echo
31 32 @echo "Compound utility targets:"
32 33 @echo "pdf latex and then runs the PDF generation"
33 34 @echo "all html and pdf"
34 35 @echo "dist all, and then puts the results in dist/"
35 36 @echo "gitwash-update update git workflow from source repo"
36 37
37 38 clean:
38 39 -rm -rf build/* dist/* $(SRCDIR)/api/generated
39 40
40 41 pdf: latex
41 42 cd build/latex && make all-pdf
42 43
43 44 all: html pdf
44 45
45 46 # For final distribution, only build HTML (our pdf is now so large as to be
46 47 # unusable, takes forever to build and just bloats the downloads). We leave
47 48 # them hardlinked at the top-level so users find them easily, though the
48 49 # original build/html dir is left in-place (useful to reload builds while
49 50 # testing).
50 51 dist: html
51 52 rm -rf html
52 53 cp -al build/html .
53 54 @echo "Build finished. Final docs are in html/"
54 55
55 56 html: api
56 57 html_noapi: clean
57 58
58 59 html html_noapi:
59 60 mkdir -p build/html build/doctrees
60 61 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
61 62 @echo
62 63 @echo "Build finished. The HTML pages are in build/html."
63 64
64 65 api: source/api/generated/gen.txt
65 66
66 67 source/api/generated/gen.txt:
67 68 python autogen_api.py
68 69 @echo "Build API docs finished."
69 70
70 71 pickle:
71 72 mkdir -p build/pickle build/doctrees
72 73 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
73 74 @echo
74 75 @echo "Build finished; now you can process the pickle files or run"
75 76 @echo " sphinx-web build/pickle"
76 77 @echo "to start the sphinx-web server."
77 78
78 79 web: pickle
79 80
80 81 htmlhelp:
81 82 mkdir -p build/htmlhelp build/doctrees
82 83 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
83 84 @echo
84 85 @echo "Build finished; now you can run HTML Help Workshop with the" \
85 86 ".hhp project file in build/htmlhelp."
86 87
87 88 qthelp:
88 89 mkdir -p build/qthelp
89 90 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
90 91 @echo
91 92 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
92 93 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
93 94 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp"
94 95 @echo "To view the help file:"
95 96 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc"
96 97
97 98 latex: api
98 99 mkdir -p build/latex build/doctrees
99 100 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
100 101 @echo
101 102 @echo "Build finished; the LaTeX files are in build/latex."
102 103 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
103 104 "run these through (pdf)latex."
104 105
105 106 changes:
106 107 mkdir -p build/changes build/doctrees
107 108 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
108 109 @echo
109 110 @echo "The overview file is in build/changes."
110 111
111 112 linkcheck:
112 113 mkdir -p build/linkcheck build/doctrees
113 114 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
114 115 @echo
115 116 @echo "Link check complete; look for any errors in the above output " \
116 117 "or in build/linkcheck/output.rst."
117 118
118 119 gitwash-update:
119 120 python ../tools/gitwash_dumper.py source/development ipython
120 121
121 122 nightly: dist
122 123 rsync -avH --delete dist/ ipython:www/doc/nightly
123 124
124 125 gh-pages: clean html
125 126 python gh-pages.py
126 127
127 128 texinfo:
128 129 mkdir -p $(BUILDDIR)/texinfo
129 130 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130 131 @echo
131 132 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
132 133 @echo "Run \`make' in that directory to run these through makeinfo" \
133 134 "(use \`make info' here to do that automatically)."
134 135
135 136 info:
136 137 mkdir -p $(BUILDDIR)/texinfo
137 138 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
138 139 @echo "Running Texinfo files through makeinfo..."
139 140 make -C $(BUILDDIR)/texinfo info
140 141 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
General Comments 0
You need to be logged in to leave comments. Login now