michael@0: # Makefile for Sphinx documentation
michael@0: #
michael@0: 
michael@0: # You can set these variables from the command line.
michael@0: SPHINXOPTS    =
michael@0: SPHINXBUILD   = sphinx-build
michael@0: PAPER         =
michael@0: BUILDDIR      = _build
michael@0: 
michael@0: # Internal variables.
michael@0: PAPEROPT_a4     = -D latex_paper_size=a4
michael@0: PAPEROPT_letter = -D latex_paper_size=letter
michael@0: ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
michael@0: 
michael@0: .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
michael@0: 
michael@0: help:
michael@0: 	@echo "Please use \`make <target>' where <target> is one of"
michael@0: 	@echo "  html       to make standalone HTML files"
michael@0: 	@echo "  dirhtml    to make HTML files named index.html in directories"
michael@0: 	@echo "  singlehtml to make a single large HTML file"
michael@0: 	@echo "  pickle     to make pickle files"
michael@0: 	@echo "  json       to make JSON files"
michael@0: 	@echo "  htmlhelp   to make HTML files and a HTML help project"
michael@0: 	@echo "  qthelp     to make HTML files and a qthelp project"
michael@0: 	@echo "  devhelp    to make HTML files and a Devhelp project"
michael@0: 	@echo "  epub       to make an epub"
michael@0: 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
michael@0: 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
michael@0: 	@echo "  text       to make text files"
michael@0: 	@echo "  man        to make manual pages"
michael@0: 	@echo "  changes    to make an overview of all changed/added/deprecated items"
michael@0: 	@echo "  linkcheck  to check all external links for integrity"
michael@0: 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
michael@0: 
michael@0: clean:
michael@0: 	-rm -rf $(BUILDDIR)/*
michael@0: 
michael@0: html:
michael@0: 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
michael@0: 	@echo
michael@0: 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
michael@0: 
michael@0: dirhtml:
michael@0: 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
michael@0: 	@echo
michael@0: 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
michael@0: 
michael@0: singlehtml:
michael@0: 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
michael@0: 	@echo
michael@0: 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
michael@0: 
michael@0: pickle:
michael@0: 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
michael@0: 	@echo
michael@0: 	@echo "Build finished; now you can process the pickle files."
michael@0: 
michael@0: json:
michael@0: 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
michael@0: 	@echo
michael@0: 	@echo "Build finished; now you can process the JSON files."
michael@0: 
michael@0: htmlhelp:
michael@0: 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
michael@0: 	@echo
michael@0: 	@echo "Build finished; now you can run HTML Help Workshop with the" \
michael@0: 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
michael@0: 
michael@0: qthelp:
michael@0: 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
michael@0: 	@echo
michael@0: 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
michael@0: 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
michael@0: 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-compressor.qhcp"
michael@0: 	@echo "To view the help file:"
michael@0: 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-compressor.qhc"
michael@0: 
michael@0: devhelp:
michael@0: 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
michael@0: 	@echo
michael@0: 	@echo "Build finished."
michael@0: 	@echo "To view the help file:"
michael@0: 	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-compressor"
michael@0: 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-compressor"
michael@0: 	@echo "# devhelp"
michael@0: 
michael@0: epub:
michael@0: 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
michael@0: 	@echo
michael@0: 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
michael@0: 
michael@0: latex:
michael@0: 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
michael@0: 	@echo
michael@0: 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
michael@0: 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
michael@0: 	      "(use \`make latexpdf' here to do that automatically)."
michael@0: 
michael@0: latexpdf:
michael@0: 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
michael@0: 	@echo "Running LaTeX files through pdflatex..."
michael@0: 	make -C $(BUILDDIR)/latex all-pdf
michael@0: 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
michael@0: 
michael@0: text:
michael@0: 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
michael@0: 	@echo
michael@0: 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
michael@0: 
michael@0: man:
michael@0: 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
michael@0: 	@echo
michael@0: 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
michael@0: 
michael@0: changes:
michael@0: 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
michael@0: 	@echo
michael@0: 	@echo "The overview file is in $(BUILDDIR)/changes."
michael@0: 
michael@0: linkcheck:
michael@0: 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
michael@0: 	@echo
michael@0: 	@echo "Link check complete; look for any errors in the above output " \
michael@0: 	      "or in $(BUILDDIR)/linkcheck/output.txt."
michael@0: 
michael@0: doctest:
michael@0: 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
michael@0: 	@echo "Testing of doctests in the sources finished, look at the " \
michael@0: 	      "results in $(BUILDDIR)/doctest/output.txt."