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