Find file
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (86 sloc) 3.4 KB
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
PAPER = a4
PYTHON = python
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck zip
@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 " pdf to make PDF from LaTeX, 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"
@echo " install to upload to github the web pages"
@echo " zip to create the zip file with examples and doc"
-rm -rf build/*
nosetests -v --with-doctest --doctest-tests --doctest-extension=rst intro/*[a-z].rst advanced/*[a-z].rst intro/summary-exercises/*.rst
mkdir -p build/html build/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
@echo "Build finished. The HTML pages are in build/html."
mkdir -p build/pickle build/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
@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
mkdir -p build/htmlhelp build/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in build/htmlhelp."
mkdir -p build/latex build/doctrees
$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) build/latex
@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."
latexpdf: latex
$(MAKE) -C build/latex all-pdf
mkdir -p build/changes build/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
@echo "The overview file is in build/changes."
mkdir -p build/linkcheck build/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in build/linkcheck/output.txt."
pdf: latex
cd build/latex ; make all-pdf ; pdfnup PythonScientific.pdf
cp build/latex/PythonScientific.pdf PythonScientific-simple.pdf
cp build/latex/PythonScientific-nup.pdf PythonScientific.pdf
#cd build/latex ; make all-pdf ; pdfnup python4science.pdf
zip: html pdf
mkdir -p build/scipy_lecture_notes ;
cp -r build/html build/scipy_lecture_notes ;
cp -r data build/scipy_lecture_notes ;
cp PythonScientific.pdf build/scipy_lecture_notes;
zip -r build/ build/scipy_lecture_notes
install: pdf html
rm -rf build/
cd build/ && \
git clone && \
cp -r html/* && \
cd && \
git add * && \
git commit -a -m 'Make install' && \
git push