Normalize build directory.
Tres Seaver
10 years ago
| 8 | 8 | # Internal variables. |
| 9 | 9 | PAPEROPT_a4 = -D latex_paper_size=a4 |
| 10 | 10 | PAPEROPT_letter = -D latex_paper_size=letter |
| 11 | ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |
| 11 | ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |
| 12 | 12 | |
| 13 | 13 | .PHONY: help clean html web pickle htmlhelp latex changes linkcheck |
| 14 | 14 | |
| 22 | 22 | @echo " linkcheck to check all external links for integrity" |
| 23 | 23 | |
| 24 | 24 | clean: |
| 25 | -rm -rf .build/* | |
| 25 | -rm -rf _build/* | |
| 26 | 26 | |
| 27 | 27 | html: |
| 28 | mkdir -p .build/html .build/doctrees | |
| 29 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html | |
| 28 | mkdir -p _build/html _build/doctrees | |
| 29 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html | |
| 30 | 30 | @echo |
| 31 | @echo "Build finished. The HTML pages are in .build/html." | |
| 31 | @echo "Build finished. The HTML pages are in _build/html." | |
| 32 | 32 | |
| 33 | 33 | pickle: |
| 34 | mkdir -p .build/pickle .build/doctrees | |
| 35 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle | |
| 34 | mkdir -p _build/pickle _build/doctrees | |
| 35 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle | |
| 36 | 36 | @echo |
| 37 | 37 | @echo "Build finished; now you can process the pickle files or run" |
| 38 | @echo " sphinx-web .build/pickle" | |
| 38 | @echo " sphinx-web _build/pickle" | |
| 39 | 39 | @echo "to start the sphinx-web server." |
| 40 | 40 | |
| 41 | 41 | web: pickle |
| 42 | 42 | |
| 43 | 43 | htmlhelp: |
| 44 | mkdir -p .build/htmlhelp .build/doctrees | |
| 45 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp | |
| 44 | mkdir -p _build/htmlhelp _build/doctrees | |
| 45 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp | |
| 46 | 46 | @echo |
| 47 | 47 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
| 48 | ".hhp project file in .build/htmlhelp." | |
| 48 | ".hhp project file in _build/htmlhelp." | |
| 49 | 49 | |
| 50 | 50 | latex: |
| 51 | mkdir -p .build/latex .build/doctrees | |
| 52 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex | |
| 51 | mkdir -p _build/latex _build/doctrees | |
| 52 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex | |
| 53 | 53 | @echo |
| 54 | @echo "Build finished; the LaTeX files are in .build/latex." | |
| 54 | @echo "Build finished; the LaTeX files are in _build/latex." | |
| 55 | 55 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
| 56 | 56 | "run these through (pdf)latex." |
| 57 | 57 | |
| 58 | 58 | changes: |
| 59 | mkdir -p .build/changes .build/doctrees | |
| 60 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes | |
| 59 | mkdir -p _build/changes _build/doctrees | |
| 60 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes | |
| 61 | 61 | @echo |
| 62 | @echo "The overview file is in .build/changes." | |
| 62 | @echo "The overview file is in _build/changes." | |
| 63 | 63 | |
| 64 | 64 | linkcheck: |
| 65 | mkdir -p .build/linkcheck .build/doctrees | |
| 66 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck | |
| 65 | mkdir -p _build/linkcheck _build/doctrees | |
| 66 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck | |
| 67 | 67 | @echo |
| 68 | 68 | @echo "Link check complete; look for any errors in the above output " \ |
| 69 | "or in .build/linkcheck/output.txt." | |
| 69 | "or in _build/linkcheck/output.txt." | |