| blob | c2ceb7c0f0d608e34403cf2eb3c5d8dac00fd8b5 |
1 # Makefile for Python documentation
2 # ---------------------------------
3 #
4 # See also the README file.
5 #
6 # This is a bit of a mess. The documents are identified by short names:
7 # api -- Python/C API Reference Manual
8 # doc -- Documenting Python
9 # ext -- Extending and Embedding the Python Interpreter
10 # lib -- Library Reference Manual
11 # mac -- Macintosh Library Modules
12 # ref -- Python Reference Manual
13 # tut -- Python Tutorial
14 # inst -- Installing Python Modules
15 # dist -- Distributing Python Modules
16 #
17 # The latex sources for each of these documents are in subdirectories
18 # with the three-letter designations above as the directory names.
19 #
20 # The main target creates DVI and PostScript for the main each of the
21 # documents. You can also do "make lib" (etc.) to create the DVI and
22 # PostScript versions of individual documents.
23 #
24 # The document classes and styles are in the texinputs/ directory.
25 # These define a number of macros that are similar in name and intent
26 # as macros in Texinfo (e.g. \code{...} and \emph{...}), as well as a
27 # number of environments for formatting function and data definitions.
28 #
29 # Everything is processed by LaTeX. See the file `README' for more
30 # information on the tools needed for processing.
31 #
32 # There's a problem with generating the index which has been solved by
33 # a sed command applied to the index file. The shell script fix_hack
34 # does this (the Makefile takes care of calling it).
35 #
36 # Additional targets attempt to convert selected LaTeX sources to
37 # various other formats. These are generally site specific because
38 # the tools used are all but universal. These targets are:
39 #
40 # html -- convert all documents from LaTeX to HTML
41 # pdf -- convert all documents from LaTeX to the
42 # Portable Document Format
43 #
44 # See the README file for more information on these targets.
45 #
46 # The formatted output is located in subdirectories. For PDF and
47 # PostScript, look in the paper-$(PAPER)/ directory. For HTML, look in
48 # the html/ directory. If you want to fix the GNU info process, look
49 # in the info/ directory; please send patches to python-docs@python.org.
51 # Customizations -- you *may* have to edit these
53 # you could set this to a4
54 PAPER=letter
56 # Ideally, you shouldn't need to edit beyond this point
58 HTMLDIR= html
60 TOOLSDIR= tools
62 # This is the *documentation* release, and is used to construct the file
63 # names of the downloadable tarballs.
67 # These must be declared phony since there
68 # are directories with matching names:
73 # Main target
79 pdf:
82 ps:
85 world: ps pdf html tarballs
88 # Targets for each document:
89 api api.ps:
92 doc doc.ps:
95 ext ext.ps:
98 lib lib.ps:
101 mac mac.ps:
104 ref ref.ps:
107 tut tut.ps:
110 inst inst.ps:
145 api.pdf:
148 doc.pdf:
151 ext.pdf:
154 lib.pdf:
157 mac.pdf:
160 ref.pdf:
163 tut.pdf:
166 inst.pdf:
173 # The remaining part of the Makefile is concerned with various
174 # conversions, as described above. See also the README file.
179 # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
180 # HTML converter. For more info on this program, see
181 # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
183 # Note that LaTeX2HTML inserts references to an icons directory in
184 # each page that it generates. I have placed a copy of this directory
185 # in the distribution to simplify the process of creating a
186 # self-contained HTML distribution; for this purpose I have also added
187 # a (trivial) index.html. Change the definition of $ICONSERVER in
188 # perl/l2hinit.perl to use a different location for the icons directory.
190 # If you have the standard LaTeX2HTML icons installed, the versions shipped
191 # with this documentation should be stored in a separate directory and used
192 # instead. The standard set does *not* include all the icons used in the
193 # Python documentation.
195 html:
198 htmlapi:
201 htmldoc:
204 htmlext:
207 htmllib:
210 htmlmac:
213 htmlref:
216 htmltut:
219 htmlinst:
222 htmldist:
225 longhtml:
229 # webchecker needs an extra flag to process the huge index from the libref
230 webcheck:
234 # Release packaging targets:
297 # convenience targets:
305 tarballs: tarpdf tarps tarhtml
313 # Only build the longhtml version for final releases; use the second
314 # version of this for pre-release versions.
315 #
316 #zips: zippdf zipps ziphtml ziplonghtml
317 zips: zippdf zipps ziphtml
325 bzips: bzippdf bzipps bziphtml
327 distfiles: tarballs zips bzips
331 # Housekeeping targets
333 # Remove temporary files; all except the following:
334 # - sources: .tex, .bib, .sty, *.cls
335 # - useful results: .dvi, .pdf, .ps, .texi, .info
342 l2hclean:
345 # Remove temporaries as well as final products