Makefile
87 lines
| 2.6 KiB
| text/x-makefile
|
MakefileLexer
/ docs / Makefile
Brian E Granger
|
r1256 | # Makefile for Sphinx documentation | ||
# | ||||
# 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) source | ||||
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck | ||||
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" | ||||
Fernando Perez
|
r1525 | @echo | ||
@echo "Compound utility targets:" | ||||
@echo "pdf latex and then runs the PDF generation" | ||||
@echo "all html and pdf" | ||||
@echo "dist all, and then puts the results in dist/" | ||||
Brian E Granger
|
r1256 | |||
clean: | ||||
-rm -rf build/* | ||||
Fernando Perez
|
r1525 | pdf: latex | ||
cd build/latex && make all-pdf | ||||
all: html pdf | ||||
dist: all | ||||
mkdir -p dist | ||||
-rm -rf dist/* | ||||
ln build/latex/IPython.pdf dist/ | ||||
cp -al build/html dist/ | ||||
@echo "Build finished. Final docs are in dist/" | ||||
Brian E Granger
|
r1256 | html: | ||
mkdir -p build/html build/doctrees | ||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html | ||||
@echo | ||||
@echo "Build finished. The HTML pages are in build/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." | ||||