# Makefile for Sphinx documentation
|
#
|
|
# You can set these variables from the command line.
|
SPHINXOPTS = -W
|
SPHINXBUILD = sphinx-build
|
PAPER =
|
BUILDDIR = _build
|
|
# Internal variables.
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
PAPEROPT_letter = -D latex_paper_size=letter
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
.PHONY: help clean html text web pickle htmlhelp latex latexpdf changes linkcheck epub doctest
|
|
help:
|
@echo "Please use \`make <target>' where <target> is one of"
|
@echo " html to make standalone HTML files"
|
@echo " text to make text 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 " latexpdf to make LaTeX files and run them through pdflatex"
|
@echo " changes to make an overview over all changed/added/deprecated items"
|
@echo " linkcheck to check all external links for integrity"
|
@echo " epub to make an epub"
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
clean:
|
-rm -rf $(BUILDDIR)/*
|
|
html:
|
mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
@echo
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
text:
|
mkdir -p $(BUILDDIR)/text $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
@echo
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/text."
|
|
pickle:
|
mkdir -p $(BUILDDIR)/pickle $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
@echo
|
@echo "Build finished; now you can process the pickle files or run"
|
@echo " sphinx-web $(BUILDDIR)/pickle"
|
@echo "to start the sphinx-web server."
|
|
web: pickle
|
|
htmlhelp:
|
mkdir -p $(BUILDDIR)/htmlhelp $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
@echo
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
latex:
|
mkdir -p $(BUILDDIR)/latex $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
cp _static/*.png $(BUILDDIR)/latex
|
./convert_images.sh
|
cp _static/latex-warning.png $(BUILDDIR)/latex
|
cp _static/latex-note.png $(BUILDDIR)/latex
|
@echo
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
@echo "Run \`make latexpdf' to build a PDF file from them."
|
|
latexpdf:
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
@echo "Running LaTeX files through pdflatex..."
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
@echo "pdflatex finished; the PDF file is in $(BUILDDIR)/latex."
|
|
changes:
|
mkdir -p $(BUILDDIR)/changes $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
@echo
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
linkcheck:
|
mkdir -p $(BUILDDIR)/linkcheck $(BUILDDIR)/doctrees
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
@echo
|
@echo "Link check complete; look for any errors in the above output " \
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
epub:
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
@echo
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
doctest:
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
@echo "Testing of doctests in the sources finished, look at the " \
|
"results in $(BUILDDIR)/doctest/output.txt."
|
