Show More
@@ -1,166 +1,163 | |||
|
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 | 22 | @echo " html standalone HTML files" |
|
23 | 23 | @echo " html_noapi same as above, without the time consuming API docs" |
|
24 | 24 | @echo " pickle pickle files (usable by e.g. sphinx-web)" |
|
25 | 25 | @echo " htmlhelp HTML files and a HTML help project" |
|
26 | 26 | @echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|
27 | 27 | @echo " texinfo Texinfo files" |
|
28 | 28 | @echo " info Texinfo files and run them through makeinfo" |
|
29 | 29 | @echo " changes an overview over all changed/added/deprecated items" |
|
30 | 30 | @echo " linkcheck check all external links for integrity (takes a long time)" |
|
31 | 31 | @echo " gh-pages clone IPython docs in ./gh-pages/ , build doc, autocommit" |
|
32 | 32 | @echo |
|
33 | 33 | @echo "Compound utility targets:" |
|
34 | 34 | @echo "pdf latex and then runs the PDF generation" |
|
35 | 35 | @echo "all html and pdf" |
|
36 | 36 | @echo "dist all, and then puts the results in dist/" |
|
37 | 37 | @echo "gitwash-update update git workflow from source repo" |
|
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 | -cd $(SRCDIR)/config/options; test -f generated && cat generated | xargs rm -f |
|
45 | 45 | -rm -rf $(SRCDIR)/config/options/generated |
|
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 |
html: |
|
|
63 | html: api autoconfig automagic | |
|
64 | 64 | html_noapi: clean_api autoconfig automagic |
|
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/generated |
|
79 | 79 | |
|
80 | 80 | source/config/options/generated: |
|
81 | 81 | python autogen_config.py |
|
82 | 82 | @echo "Created docs for config options" |
|
83 | 83 | |
|
84 | jsapi: | |
|
85 | jsdoc -c jsdoc_config.json -d ./build/jsapi_html/ | |
|
86 | ||
|
87 | 84 | api: source/api/generated/gen.txt |
|
88 | 85 | |
|
89 | 86 | source/api/generated/gen.txt: |
|
90 | 87 | python autogen_api.py |
|
91 | 88 | @echo "Build API docs finished." |
|
92 | 89 | |
|
93 | 90 | pickle: |
|
94 | 91 | mkdir -p build/pickle build/doctrees |
|
95 | 92 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
|
96 | 93 | @echo |
|
97 | 94 | @echo "Build finished; now you can process the pickle files or run" |
|
98 | 95 | @echo " sphinx-web build/pickle" |
|
99 | 96 | @echo "to start the sphinx-web server." |
|
100 | 97 | |
|
101 | 98 | web: pickle |
|
102 | 99 | |
|
103 | 100 | htmlhelp: |
|
104 | 101 | mkdir -p build/htmlhelp build/doctrees |
|
105 | 102 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
|
106 | 103 | @echo |
|
107 | 104 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
|
108 | 105 | ".hhp project file in build/htmlhelp." |
|
109 | 106 | |
|
110 | 107 | qthelp: |
|
111 | 108 | mkdir -p build/qthelp |
|
112 | 109 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp |
|
113 | 110 | @echo |
|
114 | 111 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
|
115 | 112 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
|
116 | 113 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp" |
|
117 | 114 | @echo "To view the help file:" |
|
118 | 115 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc" |
|
119 | 116 | |
|
120 | 117 | latex: api autoconfig |
|
121 | 118 | mkdir -p build/latex build/doctrees |
|
122 | 119 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
|
123 | 120 | @echo |
|
124 | 121 | @echo "Build finished; the LaTeX files are in build/latex." |
|
125 | 122 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
|
126 | 123 | "run these through (pdf)latex." |
|
127 | 124 | |
|
128 | 125 | changes: |
|
129 | 126 | mkdir -p build/changes build/doctrees |
|
130 | 127 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
|
131 | 128 | @echo |
|
132 | 129 | @echo "The overview file is in build/changes." |
|
133 | 130 | |
|
134 | 131 | linkcheck: |
|
135 | 132 | mkdir -p build/linkcheck build/doctrees |
|
136 | 133 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
|
137 | 134 | @echo |
|
138 | 135 | @echo "Link check complete; look for any errors in the above output " \ |
|
139 | 136 | "or in build/linkcheck/output.rst." |
|
140 | 137 | |
|
141 | 138 | gitwash-update: |
|
142 | 139 | python ../tools/gitwash_dumper.py source/development ipython |
|
143 | 140 | |
|
144 | 141 | nightly: dist |
|
145 | 142 | rsync -avH --delete dist/ ipython:www/doc/nightly |
|
146 | 143 | |
|
147 | 144 | gh-pages: clean html |
|
148 | 145 | # if VERSION is unspecified, it will be dev |
|
149 | 146 | # For releases, VERSION should be just the major version, |
|
150 | 147 | # e.g. VERSION=2 make gh-pages |
|
151 | 148 | python gh-pages.py $(VERSION) |
|
152 | 149 | |
|
153 | 150 | texinfo: |
|
154 | 151 | mkdir -p $(BUILDDIR)/texinfo |
|
155 | 152 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|
156 | 153 | @echo |
|
157 | 154 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
|
158 | 155 | @echo "Run \`make' in that directory to run these through makeinfo" \ |
|
159 | 156 | "(use \`make info' here to do that automatically)." |
|
160 | 157 | |
|
161 | 158 | info: |
|
162 | 159 | mkdir -p $(BUILDDIR)/texinfo |
|
163 | 160 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|
164 | 161 | @echo "Running Texinfo files through makeinfo..." |
|
165 | 162 | make -C $(BUILDDIR)/texinfo info |
|
166 | 163 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
@@ -1,77 +1,73 | |||
|
1 | 1 | @ECHO OFF |
|
2 | 2 | REM ~ Windows command line make file for Sphinx documentation |
|
3 | 3 | |
|
4 | 4 | SETLOCAL |
|
5 | 5 | |
|
6 | 6 | SET SPHINXOPTS= |
|
7 | 7 | SET SPHINXBUILD=sphinx-build |
|
8 | SET JSDOC=jsdoc | |
|
9 | 8 | SET PAPER= |
|
10 | 9 | SET SRCDIR=source |
|
11 | 10 | |
|
12 | 11 | IF "%PAPER%" == "" SET PAPER=a4 |
|
13 | 12 | SET ALLSPHINXOPTS=-d build\doctrees -D latex_paper_size=%PAPER% %SPHINXOPTS% %SRCDIR% |
|
14 | 13 | |
|
15 | 14 | FOR %%X IN (%SPHINXBUILD%.exe) DO SET P=%%~$PATH:X |
|
16 | 15 | |
|
17 | 16 | FOR %%L IN (html pickle htmlhelp latex changes linkcheck) DO ( |
|
18 | 17 | IF "%1" == "%%L" ( |
|
19 | 18 | IF "%P%" == "" ( |
|
20 | 19 | ECHO. |
|
21 | 20 | ECHO Error: Sphinx is not available. Please make sure it is correctly installed. |
|
22 | 21 | GOTO END |
|
23 | 22 | ) |
|
24 | 23 | MD build\doctrees 2>NUL |
|
25 | 24 | MD build\%1 || GOTO DIR_EXIST |
|
26 | 25 | %SPHINXBUILD% -b %1 %ALLSPHINXOPTS% build\%1 |
|
27 | 26 | IF NOT ERRORLEVEL 0 GOTO ERROR |
|
28 | 27 | ECHO. |
|
29 | 28 | ECHO Build finished. Results are in build\%1. |
|
30 | 29 | IF "%1" == "pickle" ( |
|
31 | 30 | ECHO Now you can process the pickle files or run |
|
32 | 31 | ECHO sphinx-web build\pickle to start the sphinx-web server. |
|
33 | 32 | ) |
|
34 | 33 | IF "%1" == "htmlhelp" ( |
|
35 | 34 | ECHO Now you can run HTML Help Workshop with the |
|
36 | 35 | ECHO .hhp project file in build/htmlhelp. |
|
37 | 36 | ) |
|
38 | 37 | IF "%1" == "linkcheck" ( |
|
39 | 38 | ECHO Look for any errors in the above output |
|
40 | 39 | ECHO or in build\linkcheck\output.rst. |
|
41 | 40 | ) |
|
42 | 41 | GOTO END |
|
43 | 42 | ) |
|
44 | 43 | ) |
|
45 | 44 | |
|
46 | IF "%1" == "jsapi" ( | |
|
47 | %JSDOC% -c jsdoc_config.json -d ./build/jsapi_html/ | |
|
48 | ) | |
|
49 | 45 | |
|
50 | 46 | IF "%1" == "clean" ( |
|
51 | 47 | RD /s /q build dist %SRCDIR%\api\generated 2>NUL |
|
52 | 48 | IF ERRORLEVEL 0 ECHO Build environment cleaned! |
|
53 | 49 | GOTO END |
|
54 | 50 | ) |
|
55 | 51 | |
|
56 | 52 | ECHO. |
|
57 | 53 | ECHO Please use "make [target]" where [target] is one of: |
|
58 | 54 | ECHO. |
|
59 | 55 | ECHO html to make standalone HTML files |
|
60 | 56 | ECHO jsapi to make standalone HTML files for the Javascript API |
|
61 | 57 | ECHO pickle to make pickle files (usable by e.g. sphinx-web) |
|
62 | 58 | ECHO htmlhelp to make HTML files and a HTML help project |
|
63 | 59 | ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
|
64 | 60 | ECHO changes to make an overview over all changed/added/deprecated items |
|
65 | 61 | ECHO linkcheck to check all external links for integrity |
|
66 | 62 | GOTO END |
|
67 | 63 | |
|
68 | 64 | :DIR_EXIST |
|
69 | 65 | ECHO. |
|
70 | 66 | ECHO Info: Run "make clean" to clean build environment |
|
71 | 67 | |
|
72 | 68 | :ERROR |
|
73 | 69 | ECHO. |
|
74 | 70 | ECHO Error: Build process failed! |
|
75 | 71 | |
|
76 | 72 | :END |
|
77 | 73 | ENDLOCAL No newline at end of file |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now