| blob | d849189f32589692c8e38d7210c5d65708750ae9 |
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 #
15 # The latex sources for each of these documents are in subdirectories
16 # with the three-letter designations above as the directory names.
17 #
18 # The main target creates DVI and PostScript for the main each of the
19 # documents. You can also do "make lib" (etc.) to create the DVI and
20 # PostScript versions of individual documents.
21 #
22 # The document classes and styles are in the texinputs/ directory.
23 # These define a number of macros that are similar in name and intent
24 # as macros in Texinfo (e.g. \code{...} and \emph{...}), as well as a
25 # number of environments for formatting function and data definitions.
26 #
27 # Everything is processed by LaTeX. See the file `README' for more
28 # information on the tools needed for processing.
29 #
30 # There's a problem with generating the index which has been solved by
31 # a sed command applied to the index file. The shell script fix_hack
32 # does this (the Makefile takes care of calling it).
33 #
34 # Additional targets attempt to convert selected LaTeX sources to
35 # various other formats. These are generally site specific because
36 # the tools used are all but universal. These targets are:
37 #
38 # html -- convert all documents from LaTeX to HTML
39 # pdf -- convert all documents from LaTeX to the
40 # Portable Document Format
41 #
42 # See the README file for more information on these targets.
43 #
44 # The formatted output is located in subdirectories. For PDF and
45 # PostScript, look in the paper-$(PAPER)/ directory. For HTML, look in
46 # the html/ directory. If you want to fix the GNU info process, look
47 # in the info/ directory; please send patches to python-docs@python.org.
49 # Customizations -- you *may* have to edit these
51 # you could set this to a4
52 PAPER=letter
54 # Ideally, you shouldn't need to edit beyond this point
56 HTMLDIR= html
58 TOOLSDIR= tools
60 # This is the *documentation* release, and is used to construct the file
61 # names of the downloadable tarballs.
65 # These must be declared phony since there
66 # are directories with matching names:
67 .PHONY: api doc ext lib mac ref tut
71 # Main target
77 pdf:
80 ps:
83 world: ps pdf html tarballs
86 # Targets for each document:
87 api api.ps:
90 doc doc.ps:
93 ext ext.ps:
96 lib lib.ps:
99 mac mac.ps:
102 ref ref.ps:
105 tut tut.ps:
131 api.pdf:
134 doc.pdf:
137 ext.pdf:
140 lib.pdf:
143 mac.pdf:
146 ref.pdf:
149 tut.pdf:
153 # The remaining part of the Makefile is concerned with various
154 # conversions, as described above. See also the README file.
159 # Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
160 # HTML converter. For more info on this program, see
161 # <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
163 # Note that LaTeX2HTML inserts references to an icons directory in
164 # each page that it generates. I have placed a copy of this directory
165 # in the distribution to simplify the process of creating a
166 # self-contained HTML distribution; for this purpose I have also added
167 # a (trivial) index.html. Change the definition of $ICONSERVER in
168 # perl/l2hinit.perl to use a different location for the icons directory.
170 # If you have the standard LaTeX2HTML icons installed, the versions shipped
171 # with this documentation should be stored in a separate directory and used
172 # instead. The standard set does *not* include all the icons used in the
173 # Python documentation.
175 html:
178 htmlapi:
181 htmldoc:
184 htmlext:
187 htmllib:
190 htmlmac:
193 htmlref:
196 htmltut:
200 # webchecker needs an extra flag to process the huge index from the libref
201 webcheck:
205 # Release packaging targets:
256 # convenience targets:
264 tarballs: tarpdf tarps tarhtml
271 zips: zippdf zipps ziphtml
279 bzips: bzippdf bzipps bziphtml
281 distfiles: tarballs zips bzips
285 # Housekeeping targets
287 # Remove temporary files; all except the following:
288 # - sources: .tex, .bib, .sty, *.cls
289 # - useful results: .dvi, .pdf, .ps, .texi, .info
295 l2hclean:
298 # Remove temporaries as well as final products