annotate docs/Makefile @ 16:ef39290c19af

Replace docs with include directives (rst)
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Thu, 27 Aug 2015 13:03:28 +0100
parents 8e1efafa6277
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
1 # Makefile for Sphinx documentation
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
2 #
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
3
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
4 # You can set these variables from the command line.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
5 SPHINXOPTS =
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
7 PAPER =
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
8 BUILDDIR = _build
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
9
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
10 # User-friendly check for sphinx-build
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
13 endif
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
14
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
15 # Internal variables.
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
16 PAPEROPT_a4 = -D latex_paper_size=a4
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
17 PAPEROPT_letter = -D latex_paper_size=letter
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
19 # the i18n builder cannot share the environment and doctrees with the others
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
21
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
23
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
24 help:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
25 @echo "Please use \`make <target>' where <target> is one of"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
26 @echo " html to make standalone HTML files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
27 @echo " dirhtml to make HTML files named index.html in directories"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
28 @echo " singlehtml to make a single large HTML file"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
29 @echo " pickle to make pickle files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
30 @echo " json to make JSON files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
31 @echo " htmlhelp to make HTML files and a HTML help project"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
32 @echo " qthelp to make HTML files and a qthelp project"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
33 @echo " devhelp to make HTML files and a Devhelp project"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
34 @echo " epub to make an epub"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
35 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
36 @echo " latexpdf to make LaTeX files and run them through pdflatex"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
37 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
38 @echo " text to make text files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
39 @echo " man to make manual pages"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
40 @echo " texinfo to make Texinfo files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
41 @echo " info to make Texinfo files and run them through makeinfo"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
42 @echo " gettext to make PO message catalogs"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
43 @echo " changes to make an overview of all changed/added/deprecated items"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
44 @echo " xml to make Docutils-native XML files"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
45 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
46 @echo " linkcheck to check all external links for integrity"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
48
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
49 clean:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
50 rm -rf $(BUILDDIR)/*
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
51
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
52 html:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
54 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
56
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
57 dirhtml:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
58 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
59 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
61
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
62 singlehtml:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
63 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
64 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
65 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
66
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
67 pickle:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
68 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
69 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
70 @echo "Build finished; now you can process the pickle files."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
71
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
72 json:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
73 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
74 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
75 @echo "Build finished; now you can process the JSON files."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
76
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
77 htmlhelp:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
78 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
79 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
80 @echo "Build finished; now you can run HTML Help Workshop with the" \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
81 ".hhp project file in $(BUILDDIR)/htmlhelp."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
82
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
83 qthelp:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
84 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
85 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
86 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
87 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
88 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/riboplot.qhcp"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
89 @echo "To view the help file:"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
90 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/riboplot.qhc"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
91
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
92 devhelp:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
93 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
94 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
95 @echo "Build finished."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
96 @echo "To view the help file:"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
97 @echo "# mkdir -p $$HOME/.local/share/devhelp/riboplot"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
98 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/riboplot"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
99 @echo "# devhelp"
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
100
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
101 epub:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
102 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
103 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
104 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
105
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
106 latex:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
107 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
108 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
109 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
110 @echo "Run \`make' in that directory to run these through (pdf)latex" \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
111 "(use \`make latexpdf' here to do that automatically)."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
112
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
113 latexpdf:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
114 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
115 @echo "Running LaTeX files through pdflatex..."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
116 $(MAKE) -C $(BUILDDIR)/latex all-pdf
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
117 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
118
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
119 latexpdfja:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
121 @echo "Running LaTeX files through platex and dvipdfmx..."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
122 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
123 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
124
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
125 text:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
126 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
127 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
128 @echo "Build finished. The text files are in $(BUILDDIR)/text."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
129
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
130 man:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
131 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
132 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
133 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
134
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
135 texinfo:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
136 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
137 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
138 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
139 @echo "Run \`make' in that directory to run these through makeinfo" \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
140 "(use \`make info' here to do that automatically)."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
141
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
142 info:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
143 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
144 @echo "Running Texinfo files through makeinfo..."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
145 make -C $(BUILDDIR)/texinfo info
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
146 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
147
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
148 gettext:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
149 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
150 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
151 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
152
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
153 changes:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
154 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
155 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
156 @echo "The overview file is in $(BUILDDIR)/changes."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
157
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
158 linkcheck:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
159 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
160 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
161 @echo "Link check complete; look for any errors in the above output " \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
162 "or in $(BUILDDIR)/linkcheck/output.txt."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
163
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
164 doctest:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
165 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
166 @echo "Testing of doctests in the sources finished, look at the " \
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
167 "results in $(BUILDDIR)/doctest/output.txt."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
168
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
169 xml:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
170 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
171 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
172 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
173
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
174 pseudoxml:
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
175 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
176 @echo
8e1efafa6277 Updated version
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
177 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."