OLD | NEW |
---|---|
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 = -W | 5 SPHINXOPTS = -W |
6 SPHINXBUILD = sphinx-build | 6 SPHINXBUILD = sphinx-build |
7 PAPER = | 7 PAPER = |
8 BUILDDIR = _build | 8 BUILDDIR = _build |
eliben
2013/10/02 15:57:32
Mention USER here?
| |
9 | 9 |
10 # User-friendly check for sphinx-build | 10 # User-friendly check for sphinx-build |
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) | 11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in stalled, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit h the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) | 12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in stalled, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit h the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
13 endif | 13 endif |
14 | 14 |
15 # Internal variables. | 15 # Internal variables. |
16 PAPEROPT_a4 = -D latex_paper_size=a4 | 16 PAPEROPT_a4 = -D latex_paper_size=a4 |
17 PAPEROPT_letter = -D latex_paper_size=letter | 17 PAPEROPT_letter = -D latex_paper_size=letter |
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | 18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
(...skipping 157 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
176 @echo | 176 @echo |
177 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." | 177 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
178 | 178 |
179 pseudoxml: | 179 pseudoxml: |
180 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | 180 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
181 @echo | 181 @echo |
182 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml ." | 182 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml ." |
183 | 183 |
184 devsite-prod: | 184 devsite-prod: |
185 $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-prod | 185 $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-prod |
186 rm -f $(BUILDDIR)/devsite-prod/objects.inv | |
187 rm -f $(BUILDDIR)/devsite-prod/rest-devsite-examples.html | |
186 @echo | 188 @echo |
187 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod." | 189 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod." |
188 | 190 |
191 devsite-staging: | |
192 $(SPHINXBUILD) -b devsite -D devsite_foldername=$(USER) -D devsite_produ ction_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-staging | |
193 rm -f $(BUILDDIR)/devsite-staging/objects.inv | |
194 rm -f $(BUILDDIR)/devsite-staging/rest-devsite-examples.html | |
195 @echo | |
196 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-staging ." | |
197 | |
189 devsite: | 198 devsite: |
190 $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite | 199 $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite |
191 @echo | 200 @echo |
192 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite." | 201 @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite." |
193 | 202 |
194 serve: | 203 serve: |
195 cd _build/devsite && python -m SimpleHTTPServer 8009 | 204 cd _build/devsite && python -m SimpleHTTPServer 8009 |
OLD | NEW |