1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/Makefile	Mon Dec 13 22:16:37 2010 +0300
     1.3 @@ -0,0 +1,89 @@
     1.4 +# Makefile for Sphinx documentation
     1.5 +#
     1.6 +
     1.7 +# You can set these variables from the command line.
     1.8 +SPHINXOPTS    =
     1.9 +SPHINXBUILD   = sphinx-build
    1.10 +PAPER         =
    1.11 +BUILDDIR      = build
    1.12 +
    1.13 +# Internal variables.
    1.14 +PAPEROPT_a4     = -D latex_paper_size=a4
    1.15 +PAPEROPT_letter = -D latex_paper_size=letter
    1.16 +ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
    1.17 +
    1.18 +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
    1.19 +
    1.20 +help:
    1.21 +	@echo "Please use \`make <target>' where <target> is one of"
    1.22 +	@echo "  html      to make standalone HTML files"
    1.23 +	@echo "  dirhtml   to make HTML files named index.html in directories"
    1.24 +	@echo "  pickle    to make pickle files"
    1.25 +	@echo "  json      to make JSON files"
    1.26 +	@echo "  htmlhelp  to make HTML files and a HTML help project"
    1.27 +	@echo "  qthelp    to make HTML files and a qthelp project"
    1.28 +	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
    1.29 +	@echo "  changes   to make an overview of all changed/added/deprecated items"
    1.30 +	@echo "  linkcheck to check all external links for integrity"
    1.31 +	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
    1.32 +
    1.33 +clean:
    1.34 +	-rm -rf $(BUILDDIR)/*
    1.35 +
    1.36 +html:
    1.37 +	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    1.38 +	@echo
    1.39 +	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
    1.40 +
    1.41 +dirhtml:
    1.42 +	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
    1.43 +	@echo
    1.44 +	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
    1.45 +
    1.46 +pickle:
    1.47 +	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
    1.48 +	@echo
    1.49 +	@echo "Build finished; now you can process the pickle files."
    1.50 +
    1.51 +json:
    1.52 +	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
    1.53 +	@echo
    1.54 +	@echo "Build finished; now you can process the JSON files."
    1.55 +
    1.56 +htmlhelp:
    1.57 +	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
    1.58 +	@echo
    1.59 +	@echo "Build finished; now you can run HTML Help Workshop with the" \
    1.60 +	      ".hhp project file in $(BUILDDIR)/htmlhelp."
    1.61 +
    1.62 +qthelp:
    1.63 +	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
    1.64 +	@echo
    1.65 +	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
    1.66 +	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
    1.67 +	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/allpy.qhcp"
    1.68 +	@echo "To view the help file:"
    1.69 +	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/allpy.qhc"
    1.70 +
    1.71 +latex:
    1.72 +	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
    1.73 +	@echo
    1.74 +	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
    1.75 +	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
    1.76 +	      "run these through (pdf)latex."
    1.77 +
    1.78 +changes:
    1.79 +	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
    1.80 +	@echo
    1.81 +	@echo "The overview file is in $(BUILDDIR)/changes."
    1.82 +
    1.83 +linkcheck:
    1.84 +	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
    1.85 +	@echo
    1.86 +	@echo "Link check complete; look for any errors in the above output " \
    1.87 +	      "or in $(BUILDDIR)/linkcheck/output.txt."
    1.88 +
    1.89 +doctest:
    1.90 +	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
    1.91 +	@echo "Testing of doctests in the sources finished, look at the " \
    1.92 +	      "results in $(BUILDDIR)/doctest/output.txt."