Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
89 lines (73 sloc) 2.93 KB
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
# 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 dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
-rm -rf build/*
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
@echo "Build finished. The HTML pages are in build/html."
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
@echo "Build finished. The HTML pages are in build/dirhtml."
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
@echo "Build finished; now you can process the pickle files."
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
@echo "Build finished; now you can process the JSON files."
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in build/htmlhelp."
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in build/qthelp, like this:"
@echo "# qcollectiongenerator build/qthelp/Django Test Utils.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile build/qthelp/Django Test Utils.qhc"
$(SPHINXBUILD) -b latex $(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."
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
@echo "The overview file is in build/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in build/linkcheck/output.txt."
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in build/doctest/output.txt."
Jump to Line
Something went wrong with that request. Please try again.