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