allpy: docs/Makefile annotate

allpy

annotate docs/Makefile @ 432:c4acc245244c

blocks3d/wt improvement make symbolic link files/resources to wt resoure files (instead of copy them to files/resources)

author	boris <bnagaev@gmail.com>
date	Tue, 15 Feb 2011 00:07:57 +0300
parents
children

rev	line source
me@254	1 # Makefile for Sphinx documentation
me@254	2 #
me@254	3
me@254	4 # You can set these variables from the command line.
me@254	5 SPHINXOPTS =
me@254	6 SPHINXBUILD = sphinx-build
me@254	7 PAPER =
me@254	8 BUILDDIR = build
me@254	9
me@254	10 # Internal variables.
me@254	11 PAPEROPT_a4 = -D latex_paper_size=a4
me@254	12 PAPEROPT_letter = -D latex_paper_size=letter
me@254	13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
me@254	14
me@254	15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
me@254	16
me@254	17 help:
me@254	18 @echo "Please use \`make <target>' where <target> is one of"
me@254	19 @echo " html to make standalone HTML files"
me@254	20 @echo " dirhtml to make HTML files named index.html in directories"
me@254	21 @echo " pickle to make pickle files"
me@254	22 @echo " json to make JSON files"
me@254	23 @echo " htmlhelp to make HTML files and a HTML help project"
me@254	24 @echo " qthelp to make HTML files and a qthelp project"
me@254	25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
me@254	26 @echo " changes to make an overview of all changed/added/deprecated items"
me@254	27 @echo " linkcheck to check all external links for integrity"
me@254	28 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
me@254	29
me@254	30 clean:
me@254	31 -rm -rf $(BUILDDIR)/*
me@254	32
me@254	33 html:
me@254	34 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
me@254	35 @echo
me@254	36 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
me@254	37
me@254	38 dirhtml:
me@254	39 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
me@254	40 @echo
me@254	41 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
me@254	42
me@254	43 pickle:
me@254	44 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
me@254	45 @echo
me@254	46 @echo "Build finished; now you can process the pickle files."
me@254	47
me@254	48 json:
me@254	49 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
me@254	50 @echo
me@254	51 @echo "Build finished; now you can process the JSON files."
me@254	52
me@254	53 htmlhelp:
me@254	54 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
me@254	55 @echo
me@254	56 @echo "Build finished; now you can run HTML Help Workshop with the" \
me@254	57 ".hhp project file in $(BUILDDIR)/htmlhelp."
me@254	58
me@254	59 qthelp:
me@254	60 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
me@254	61 @echo
me@254	62 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
me@254	63 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
me@254	64 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/allpy.qhcp"
me@254	65 @echo "To view the help file:"
me@254	66 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/allpy.qhc"
me@254	67
me@254	68 latex:
me@254	69 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
me@254	70 @echo
me@254	71 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
me@254	72 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
me@254	73 "run these through (pdf)latex."
me@254	74
me@254	75 changes:
me@254	76 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
me@254	77 @echo
me@254	78 @echo "The overview file is in $(BUILDDIR)/changes."
me@254	79
me@254	80 linkcheck:
me@254	81 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
me@254	82 @echo
me@254	83 @echo "Link check complete; look for any errors in the above output " \
me@254	84 "or in $(BUILDDIR)/linkcheck/output.txt."
me@254	85
me@254	86 doctest:
me@254	87 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
me@254	88 @echo "Testing of doctests in the sources finished, look at the " \
me@254	89 "results in $(BUILDDIR)/doctest/output.txt."