allpy
view docs/Makefile @ 1150:a514dd131bf4
pair-cores/web: add internal link to example from alignment input field
author | Boris Nagaev <bnagaev@gmail.com> |
---|---|
date | Tue, 15 Jan 2013 18:31:47 +0400 |
parents | |
children |
line source
1 # Makefile for Sphinx documentation
2 #
4 # You can set these variables from the command line.
10 # Internal variables.
15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
17 help:
18 @echo "Please use \`make <target>' where <target> is one of"
19 @echo " html to make standalone HTML files"
20 @echo " dirhtml to make HTML files named index.html in directories"
21 @echo " pickle to make pickle files"
22 @echo " json to make JSON files"
23 @echo " htmlhelp to make HTML files and a HTML help project"
24 @echo " qthelp to make HTML files and a qthelp project"
25 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26 @echo " changes to make an overview of all changed/added/deprecated items"
27 @echo " linkcheck to check all external links for integrity"
28 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
30 clean:
33 html:
35 @echo
36 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
38 dirhtml:
40 @echo
41 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
43 pickle:
45 @echo
46 @echo "Build finished; now you can process the pickle files."
48 json:
50 @echo
51 @echo "Build finished; now you can process the JSON files."
53 htmlhelp:
55 @echo
57 ".hhp project file in $(BUILDDIR)/htmlhelp."
59 qthelp:
61 @echo
63 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/allpy.qhcp"
65 @echo "To view the help file:"
66 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/allpy.qhc"
68 latex:
70 @echo
71 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
73 "run these through (pdf)latex."
75 changes:
77 @echo
78 @echo "The overview file is in $(BUILDDIR)/changes."
80 linkcheck:
82 @echo
84 "or in $(BUILDDIR)/linkcheck/output.txt."
86 doctest:
89 "results in $(BUILDDIR)/doctest/output.txt."