| 1 | # Makefile for Sphinx documentation |
|---|
| 2 | # |
|---|
| 3 | |
|---|
| 4 | # You can set these variables from the command line. |
|---|
| 5 | SPHINXOPTS = |
|---|
| 6 | SPHINXBUILD = sphinx-build |
|---|
| 7 | PAPER = |
|---|
| 8 | |
|---|
| 9 | # Internal variables. |
|---|
| 10 | DOC = ./doc |
|---|
| 11 | PAPEROPT_a4 = -D latex_paper_size=a4 |
|---|
| 12 | PAPEROPT_letter = -D latex_paper_size=letter |
|---|
| 13 | ALLSPHINXOPTS = -d $(DOC)/.build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|---|
| 14 | |
|---|
| 15 | .PHONY: help clean html web pickle htmlhelp latex changes linkcheck |
|---|
| 16 | |
|---|
| 17 | help: |
|---|
| 18 | @echo "Please use \`make <target>' where <target> is one of" |
|---|
| 19 | @echo " html to make standalone HTML files" |
|---|
| 20 | @echo " pickle to make pickle files (usable by e.g. sphinx-web)" |
|---|
| 21 | @echo " htmlhelp to make HTML files and a HTML help project" |
|---|
| 22 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|---|
| 23 | @echo " changes to make an overview over all changed/added/deprecated items" |
|---|
| 24 | @echo " linkcheck to check all external links for integrity" |
|---|
| 25 | |
|---|
| 26 | clean: |
|---|
| 27 | -rm -rf $(DOC) |
|---|
| 28 | |
|---|
| 29 | html: |
|---|
| 30 | mkdir -p $(DOC) $(DOC)/.build/doctrees |
|---|
| 31 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOC) |
|---|
| 32 | @echo |
|---|
| 33 | @echo "Build finished. The HTML pages are in $(DOC)." |
|---|
| 34 | |
|---|
| 35 | # find $(DOC) -name .svn -type d -exec /bin/rm -rf {} ';' |
|---|
| 36 | |
|---|
| 37 | pickle: |
|---|
| 38 | mkdir -p $(DOC)/.build/pickle $(DOC)/.build/doctrees |
|---|
| 39 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(DOC)/.build/pickle |
|---|
| 40 | @echo |
|---|
| 41 | @echo "Build finished; now you can process the pickle files or run" |
|---|
| 42 | @echo " sphinx-web $(DOC)/.build/pickle" |
|---|
| 43 | @echo "to start the sphinx-web server." |
|---|
| 44 | |
|---|
| 45 | web: pickle |
|---|
| 46 | |
|---|
| 47 | htmlhelp: |
|---|
| 48 | mkdir -p $(DOC)/.build/htmlhelp $(DOC)/.build/doctrees |
|---|
| 49 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(DOC)/.build/htmlhelp |
|---|
| 50 | @echo |
|---|
| 51 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
|---|
| 52 | ".hhp project file in $(DOC)/.build/htmlhelp." |
|---|
| 53 | |
|---|
| 54 | latex: |
|---|
| 55 | mkdir -p $(DOC)/.build/latex $(DOC)/.build/doctrees |
|---|
| 56 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(DOC)/.build/latex |
|---|
| 57 | @echo |
|---|
| 58 | @echo "Build finished; the LaTeX files are in $(DOC)/.build/latex." |
|---|
| 59 | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
|---|
| 60 | "run these through (pdf)latex." |
|---|
| 61 | |
|---|
| 62 | #sed -i bak 's/includegraphics/includegraphics\[scale=0.45\]/g' "$(DOC)/.build/latex/PostGISIntro.tex" |
|---|
| 63 | |
|---|
| 64 | changes: |
|---|
| 65 | mkdir -p $(DOC)/.build/changes $(DOC)/.build/doctrees |
|---|
| 66 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(DOC)/.build/changes |
|---|
| 67 | @echo |
|---|
| 68 | @echo "The overview file is in $(DOC)/.build/changes." |
|---|
| 69 | |
|---|
| 70 | linkcheck: |
|---|
| 71 | mkdir -p $(DOC)/.build/linkcheck $(DOC)/.build/doctrees |
|---|
| 72 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(DOC)/.build/linkcheck |
|---|
| 73 | @echo |
|---|
| 74 | @echo "Link check complete; look for any errors in the above output " \ |
|---|
| 75 | "or in $(DOC)/.build/linkcheck/output.txt." |
|---|
