Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 73827c6

Browse files
gvanrossumgvanrossum
committed
use macros more; added some more docs
1 parent 86cb092 commit 73827c6

1 file changed

Lines changed: 49 additions & 36 deletions

File tree

‎Doc/Makefile‎

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Makefile for Python documentation
22
# ---------------------------------
33
#
4+
# See also the README file.
5+
#
46
# This is a bit of a mess. The main documents are:
57
# tut -- Tutorial (file tut.tex)
68
# lib -- Library Reference (file lib.tex, inputs lib*.tex)
@@ -40,15 +42,28 @@
4042
# lib.texi -- convert lib from LaTeX to Texinfo
4143
# lib.info -- convert lib from Texinfo to Emacs INFO
4244
# libwww -- convert lib from Texinfo to HTML
45+
# See the README file for more info on these targets.
46+
47+
# Customizations -- you *may* have to edit these
48+
49+
# Where are the various programs?
50+
LATEX= latex
51+
BIBTEX= bibtex
52+
EMACS= emacs
53+
DVIPS= dvips -f
54+
MAKEINDEX= makeindex
55+
PYTHON= python
56+
MAKEINFO= makeinfo
57+
L2H= /ufs/guido/l2h/latex2html
58+
L2HARGS= -address $$USER@`domainname` -dont_include myformat
4359

44-
# Where's dvips?
45-
DVIPS= dvips -f
60+
# Install destination -- not used now but might be useful some time...
61+
DESTDIR= /usr/local
62+
LIBDESTDIR= $DESTDIR/lib
63+
LIBDEST= $LIBDESTDIR/python
64+
DOCDESTDIR= $LIBDEST/doc
4665

47-
# Install destination -- actually not used
48-
DESTDIR=/usr/local
49-
LIBDESTDIR=$DESTDIR/lib
50-
LIBDEST=$LIBDESTDIR/python
51-
DOCDESTDIR=$LIBDEST/doc
66+
# Ideally, you shouldn't need to edit beyond this point
5267

5368
# Main target
5469
all: tut.dvi lib.dvi ref.dvi ext.dvi
@@ -67,18 +82,18 @@ tut.dvi lib.dvi ref.dvi ext.dvi: myformat.sty fix_hack
6782

6883
# Tutorial document
6984
tut.dvi: tut.tex
70-
latex tut
71-
latex tut
85+
$(LATEX) tut
86+
$(LATEX) tut
7287
$(DVIPS) tut >tut.ps
7388

7489
# Reference document
7590
ref.dvi: ref.tex ref1.tex ref2.tex ref3.tex ref4.tex ref5.tex ref6.tex \
7691
ref7.tex ref8.tex
7792
touch ref.ind
78-
latex ref
93+
$(LATEX) ref
7994
./fix_hack ref.idx
80-
makeindex ref
81-
latex ref
95+
$(MAKEINDEX) ref
96+
$(LATEX) ref
8297
$(DVIPS) ref >ref.ps
8398

8499
# LaTeX source files for the Python Library Reference
@@ -114,52 +129,52 @@ libwhrandom.tex libwww.tex
114129
# Library document
115130
lib.dvi: $(LIBFILES)
116131
touch lib.ind
117-
latex lib
132+
$(LATEX) lib
118133
./fix_hack lib.idx
119-
makeindex lib
120-
latex lib
134+
$(MAKEINDEX) lib
135+
$(LATEX) lib
121136
$(DVIPS) lib >lib.ps
122137

123138
# Extensions document
124139
ext.dvi: ext.tex
125140
touch ext.ind
126-
latex ext
141+
$(LATEX) ext
127142
./fix_hack ext.idx
128-
makeindex ext
129-
latex ext
143+
$(MAKEINDEX) ext
144+
$(LATEX) ext
130145
$(DVIPS) ext >ext.ps
131146

132147
# Quarterly document
133148
qua.dvi: qua.tex quabib.bib
134-
latex qua
135-
bibtex qua
136-
latex qua
137-
latex qua
149+
$(LATEX) qua
150+
$(BIBTEX) qua
151+
$(LATEX) qua
152+
$(BIBTEX) qua
138153
$(DVIPS) qua >qua.ps
139154

140155

141156
# The remaining part of the Makefile is concerned with various
142-
# conversions, as described above.
157+
# conversions, as described above. See also the README file.
143158

144159
lib.texi: lib*.tex texipre.dat texipost.dat partparse.py fix.el
145-
python partparse.py -o @lib.texi `./whichlibs`
146-
emacs -batch -l fix.el -f save-buffer -kill
160+
$(PYTHON) partparse.py -o @lib.texi `./whichlibs`
161+
$(EMACS) -batch -l fix.el -f save-buffer -kill
147162
mv @lib.texi lib.texi
148163

149164
.PRECIOUS: lib.texi
150165

151166
python-lib.info: lib.texi
152-
-makeinfo --footnote-style end --fill-column 72 --paragraph-indent 0 \
153-
lib.texi
167+
-$(MAKEINFO) --footnote-style end --fill-column 72 \
168+
--paragraph-indent 0 lib.texi
154169

155170
lib.info: python-lib.info
156171

157172
# This target is very local to CWI...
158173
libwww: lib.texi
159-
python texi2html.py -d lib.texi /ufs/guido/public_html/python-lib
174+
$(PYTHON) texi2html.py -d lib.texi /ufs/guido/public_html/python-lib
160175

161-
# Targets to convert the manuals to HTML using Nikos Drakos' excellent
162-
# LaTeX to HTML Converter. For more info on this program, see
176+
# Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
177+
# HTML converter. For more info on this program, see
163178
# <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
164179
# (I've had some trouble getting this to work with the netpbm version
165180
# of the pbmplus library; ppmtogif dumped core because giftopnm
@@ -168,15 +183,13 @@ libwww: lib.texi
168183
# You can probably also use "pbmtopgm | pgmtoppm"...
169184

170185
# In order to use these targets, you must edit the definition of L2H
171-
# in the Makefile to point to the latex2html program. Note that
172-
# LaTeX2HTML inserts references to an "icons" directory in each page
173-
# that it generates. You can customize where these icons are to be
174-
# found; I generally make it point to "../icons" and then create a
186+
# earlier in the Makefile to point to the latex2html program. Note
187+
# that LaTeX2HTML inserts references to an "icons" directory in each
188+
# page that it generates. You can customize where these icons are to
189+
# be found; I generally make it point to "../icons" and then create a
175190
# symbolic link to the icons directory in the LaTeX2HTML source at the
176191
# appropriate place.
177192

178-
L2H= /ufs/guido/l2h/latex2html
179-
L2HARGS=-address $$USER@`domainname` -dont_include myformat
180193
l2h: l2htut l2href l2hext
181194

182195
l2htut: tut

0 commit comments

Comments
 (0)