1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
|
# Makefile for Sphinx documentation
#
VER = 0.9.5
DEBVER = 0.8.6.1-1
WINVER = 0.8.6.1
LNXVER = 0.9-rc1
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
all: html
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " pickle to make pickle files (usable by e.g. sphinx-web)"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
clean:
-rm -rf .build/*
html:
mkdir -p .build/html .build/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
@echo
@echo "Build finished. The HTML pages are in .build/html."
@perl -i -p -e 's/DEBVER/$(DEBVER)/g' .build/html/misc/download.html
@perl -i -p -e 's/WINVER/$(WINVER)/g' .build/html/misc/download.html
@perl -i -p -e 's/LNXVER/$(LNXVER)/g' .build/html/misc/download.html
@perl -i -p -e 's/VER/$(VER)/g' .build/html/misc/download.html
@perl -i -p -e 's/VER/$(VER)/g' .build/html/misc/tutorial.html
pickle:
mkdir -p .build/pickle .build/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
@echo
@echo "Build finished; now you can process the pickle files or run"
@echo " sphinx-web .build/pickle"
@echo "to start the sphinx-web server."
web: pickle
htmlhelp:
mkdir -p .build/htmlhelp .build/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in .build/htmlhelp."
latex:
mkdir -p .build/latex .build/doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
@echo
@echo "Build finished; the LaTeX files are in .build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
mkdir -p .build/changes .build/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
@echo
@echo "The overview file is in .build/changes."
linkcheck:
mkdir -p .build/linkcheck .build/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in .build/linkcheck/output.txt."
rsync: html
rsync -r --delete --progress --stats .build/html/ www3:docs/sqlkit/
pdf: latex
cd .build/latex; make all-pdf
Print -s -o "-b 20" .build/latex/sqlkit.pdf
gv --orientation=seascape .build/latex/sqlkit.2.ps
galeon:
galeon .build/html/index.html
firefox:
firefox .build/html/index.html
chtml: clean html
refs:
find -name \*rst -exec grep -oE '\.\. \_([^:]+):\s*' {} \;
css:
cp static/*css ./.build/html/_static/
cp ./static/AnythingSlider/css/page.css ./.build/html/_static/AnythingSlider
refresh:
touch misc/tour.rst misc/download.rst misc/sqledit.rst
make
|