##// END OF EJS Templates
Add extra warnings in docs, and improve Makefile....
Matthias Bussonnier -
Show More
@@ -1,164 +1,164
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 PYTHON = python
11 11
12 12 # Internal variables.
13 13 PAPEROPT_a4 = -D latex_paper_size=a4
14 14 PAPEROPT_letter = -D latex_paper_size=letter
15 15 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
16 16
17 17 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
18 18
19 19 default: html
20 20
21 21 help:
22 22 @echo "Please use \`make <target>' where <target> is one of"
23 23 @echo " html standalone HTML files"
24 24 @echo " html_noapi same as above, without the time consuming API docs"
25 25 @echo " pickle pickle files (usable by e.g. sphinx-web)"
26 26 @echo " htmlhelp HTML files and a HTML help project"
27 27 @echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter"
28 28 @echo " texinfo Texinfo files"
29 29 @echo " info Texinfo files and run them through makeinfo"
30 30 @echo " changes an overview over all changed/added/deprecated items"
31 31 @echo " linkcheck check all external links for integrity (takes a long time)"
32 32 @echo " gh-pages clone IPython docs in ./gh-pages/ , build doc, autocommit"
33 33 @echo
34 34 @echo "Compound utility targets:"
35 35 @echo "pdf latex and then runs the PDF generation"
36 36 @echo "all html and pdf"
37 37 @echo "dist all, and then puts the results in dist/"
38 38
39 39 clean_api:
40 40 -rm -rf $(SRCDIR)/api/generated
41 41
42 42 clean: clean_api
43 43 -rm -rf build/* dist/*
44 44 -rm -f $(SRCDIR)/config/options/config-generated.txt
45 45 -rm -f $(SRCDIR)/config/shortcuts/*.csv
46 46 -rm -f $(SRCDIR)/interactive/magics-generated.txt
47 47
48 48 pdf: latex
49 49 cd build/latex && make all-pdf
50 50
51 51 all: html pdf
52 52
53 53 # For final distribution, only build HTML (our pdf is now so large as to be
54 54 # unusable, takes forever to build and just bloats the downloads). We leave
55 55 # them hardlinked at the top-level so users find them easily, though the
56 56 # original build/html dir is left in-place (useful to reload builds while
57 57 # testing).
58 58 dist: html
59 59 rm -rf html
60 60 cp -al build/html .
61 61 @echo "Build finished. Final docs are in html/"
62 62
63 63 html: api autoconfig automagic autogen_shortcuts
64 64 html_noapi: clean_api autoconfig automagic autogen_shortcuts
65 65
66 66 html html_noapi:
67 67 mkdir -p build/html build/doctrees
68 68 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
69 69 @echo
70 70 @echo "Build finished. The HTML pages are in build/html."
71 71
72 72 automagic: source/interactive/magics-generated.txt
73 73
74 74 source/interactive/magics-generated.txt: autogen_magics.py
75 75 $(PYTHON) autogen_magics.py
76 76 @echo "Created docs for line & cell magics"
77 77
78 78 autoconfig: source/config/options/config-generated.txt
79 79
80 80 source/config/options/config-generated.txt:
81 81 $(PYTHON) autogen_config.py
82 82 @echo "Created docs for config options"
83 83
84 84 api: source/api/generated/gen.txt
85 85
86 86 source/api/generated/gen.txt:
87 87 $(PYTHON) autogen_api.py
88 88 @echo "Build API docs finished."
89 89
90 autogen_shortcuts:
90 autogen_shortcuts: autogen_shortcuts.py ../IPython/terminal/interactiveshell.py
91 91 $(PYTHON) autogen_shortcuts.py
92 92 @echo "Created docs for shortcuts"
93 93
94 94 pickle:
95 95 mkdir -p build/pickle build/doctrees
96 96 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
97 97 @echo
98 98 @echo "Build finished; now you can process the pickle files or run"
99 99 @echo " sphinx-web build/pickle"
100 100 @echo "to start the sphinx-web server."
101 101
102 102 web: pickle
103 103
104 104 htmlhelp:
105 105 mkdir -p build/htmlhelp build/doctrees
106 106 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
107 107 @echo
108 108 @echo "Build finished; now you can run HTML Help Workshop with the" \
109 109 ".hhp project file in build/htmlhelp."
110 110
111 111 qthelp:
112 112 mkdir -p build/qthelp
113 113 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
114 114 @echo
115 115 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
116 116 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
117 117 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp"
118 118 @echo "To view the help file:"
119 119 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc"
120 120
121 121 latex: api autoconfig
122 122 mkdir -p build/latex build/doctrees
123 123 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
124 124 @echo
125 125 @echo "Build finished; the LaTeX files are in build/latex."
126 126 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
127 127 "run these through (pdf)latex."
128 128
129 129 changes:
130 130 mkdir -p build/changes build/doctrees
131 131 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
132 132 @echo
133 133 @echo "The overview file is in build/changes."
134 134
135 135 linkcheck:
136 136 mkdir -p build/linkcheck build/doctrees
137 137 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
138 138 @echo
139 139 @echo "Link check complete; look for any errors in the above output " \
140 140 "or in build/linkcheck/output.rst."
141 141
142 142 nightly: dist
143 143 rsync -avH --delete dist/ ipython:www/doc/nightly
144 144
145 145 gh-pages: clean html
146 146 # if VERSION is unspecified, it will be dev
147 147 # For releases, VERSION should be just the major version,
148 148 # e.g. VERSION=2 make gh-pages
149 149 $(PYTHON) gh-pages.py $(VERSION)
150 150
151 151 texinfo:
152 152 mkdir -p $(BUILDDIR)/texinfo
153 153 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154 154 @echo
155 155 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
156 156 @echo "Run \`make' in that directory to run these through makeinfo" \
157 157 "(use \`make info' here to do that automatically)."
158 158
159 159 info:
160 160 mkdir -p $(BUILDDIR)/texinfo
161 161 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
162 162 @echo "Running Texinfo files through makeinfo..."
163 163 make -C $(BUILDDIR)/texinfo info
164 164 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
@@ -1,25 +1,31
1 1 =================
2 2 IPython shortcuts
3 3 =================
4 4
5 5 Available shortcut in IPython terminal.
6 6
7 .. warnings::
8
9 This list is automatically generated, and may not hold all the available
10 shortcut. In particular, it may depends on the version of ``prompt_toolkit``
11 installed during the generation of this page.
12
7 13
8 14 Single Filtered shortcuts
9 15 =========================
10 16
11 17 .. csv-table::
12 18 :header: Shortcut,Filter,Description
13 19 :widths: 30, 30, 100
14 20 :delim: tab
15 21 :file: single_filtered.csv
16 22
17 23
18 24 Multi Filtered shortcuts
19 25 =========================
20 26
21 27 .. csv-table::
22 28 :header: Shortcut,Filter,Description
23 29 :widths: 30, 30, 100
24 30 :delim: tab
25 31 :file: multi_filtered.csv
General Comments 0
You need to be logged in to leave comments. Login now