~bzr-pqm/bzr/bzr.dev

# 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) .

# Note that this assumes name of the output dir is same as name of the rule.

define make_output_dirs

# Create output directory (only needed for sphinx < 0.5)

[ -d _build ] || mkdir _build

[ -d "_build/$@" ] || mkdir "_build/$@"

# Workaround for a bug in sphinx < 0.5 where it tries to delete

# nonexistent static dirs and does not catch the exception.  This was

# fixed in svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

# at r65551 and merged as 280b62246342 in hg branch released as 0.5.

[ -d "_build/$@/_static" ] || mkdir "_build/$@/_static"

for fn in _static/*; do \

    [ ! -d "$$fn" ] && continue; \

    [ -d "_build/$@/$$fn" ] || mkdir "_build/$@/$$fn"; \

done

endef

.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest

help:

	@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)"

clean:

	-rm -rf _build/*

html:

	$(make_output_dirs)

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html

	@echo

	@echo "Build finished. The HTML pages are in _build/html."

dirhtml:

	$(make_output_dirs)

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml

	@echo

	@echo "Build finished. The HTML pages are in _build/dirhtml."

pickle:

	$(make_output_dirs)

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle

	@echo

	@echo "Build finished; now you can process the pickle files."

json:

	$(make_output_dirs)

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json

	@echo

	@echo "Build finished; now you can process the JSON files."

htmlhelp:

	$(make_output_dirs)

	$(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."

qthelp:

	$(make_output_dirs)

	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp

	@echo

	@echo "Build finished; now you can run "qcollectiongenerator" with the" \

	      ".qhcp project file in _build/qthelp, like this:"

	@echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp"

	@echo "To view the help file:"

	@echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc"

latex:

	$(make_output_dirs)

	$(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:

	$(make_output_dirs)

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes

	@echo

	@echo "The overview file is in _build/changes."

linkcheck:

	$(make_output_dirs)

	$(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."

doctest:

	$(make_output_dirs)

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest

	@echo "Testing of doctests in the sources finished, look at the " \

	      "results in _build/doctest/output.txt."