##// END OF EJS Templates
added gh-pages to `make clean`
MinRK -
Show More
@@ -1,107 +1,107
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
10 10 # Internal variables.
11 11 PAPEROPT_a4 = -D latex_paper_size=a4
12 12 PAPEROPT_letter = -D latex_paper_size=letter
13 13 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
14 14
15 15 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
16 16
17 17 default: html
18 18
19 19 help:
20 20 @echo "Please use \`make <target>' where <target> is one of"
21 21 @echo " html to make standalone HTML files"
22 22 @echo " pickle to make pickle files (usable by e.g. sphinx-web)"
23 23 @echo " htmlhelp to make HTML files and a HTML help project"
24 24 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25 25 @echo " changes to make an overview over all changed/added/deprecated items"
26 26 @echo " linkcheck to check all external links for integrity"
27 27 @echo
28 28 @echo "Compound utility targets:"
29 29 @echo "pdf latex and then runs the PDF generation"
30 30 @echo "all html and pdf"
31 31 @echo "dist all, and then puts the results in dist/"
32 32 @echo "gitwash-update update git workflow from source repo"
33 33
34 34 clean:
35 -rm -rf build/* dist/* $(SRCDIR)/api/generated
35 -rm -rf build/* dist/* $(SRCDIR)/api/generated gh-pages
36 36
37 37 pdf: latex
38 38 cd build/latex && make all-pdf
39 39
40 40 all: html pdf
41 41
42 42 dist: all
43 43 mkdir -p dist
44 44 rm -rf dist/*
45 45 ln build/latex/ipython.pdf dist/
46 46 cp -al build/html dist/
47 47 @echo "Build finished. Final docs are in dist/"
48 48
49 49 html: api
50 50 mkdir -p build/html build/doctrees
51 51 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
52 52 @echo
53 53 @echo "Build finished. The HTML pages are in build/html."
54 54
55 55 api: source/api/generated/gen.txt
56 56
57 57 source/api/generated/gen.txt:
58 58 python autogen_api.py
59 59 @echo "Build API docs finished."
60 60
61 61 pickle:
62 62 mkdir -p build/pickle build/doctrees
63 63 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
64 64 @echo
65 65 @echo "Build finished; now you can process the pickle files or run"
66 66 @echo " sphinx-web build/pickle"
67 67 @echo "to start the sphinx-web server."
68 68
69 69 web: pickle
70 70
71 71 htmlhelp:
72 72 mkdir -p build/htmlhelp build/doctrees
73 73 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
74 74 @echo
75 75 @echo "Build finished; now you can run HTML Help Workshop with the" \
76 76 ".hhp project file in build/htmlhelp."
77 77
78 78 latex: api
79 79 mkdir -p build/latex build/doctrees
80 80 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
81 81 @echo
82 82 @echo "Build finished; the LaTeX files are in build/latex."
83 83 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
84 84 "run these through (pdf)latex."
85 85
86 86 changes:
87 87 mkdir -p build/changes build/doctrees
88 88 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
89 89 @echo
90 90 @echo "The overview file is in build/changes."
91 91
92 92 linkcheck:
93 93 mkdir -p build/linkcheck build/doctrees
94 94 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
95 95 @echo
96 96 @echo "Link check complete; look for any errors in the above output " \
97 97 "or in build/linkcheck/output.txt."
98 98
99 99 gitwash-update:
100 100 python ../tools/gitwash_dumper.py source/development ipython
101 101 cd source/development/gitwash && rename 's/.rst/.txt/' *.rst
102 102
103 103 nightly: dist
104 104 rsync -avH --delete dist/ ipython:www/doc/nightly
105 105
106 106 gh-pages: html
107 107 sh update_ghpages.sh
General Comments 0
You need to be logged in to leave comments. Login now