cpython/Doc/Makefile
Guido van Rossum e7ba495627 Merged revisions 55631-55794 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/p3yk

................
  r55636 | neal.norwitz | 2007-05-29 00:06:39 -0700 (Tue, 29 May 2007) | 149 lines

  Merged revisions 55506-55635 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r55507 | georg.brandl | 2007-05-22 07:28:17 -0700 (Tue, 22 May 2007) | 2 lines

    Remove the "panel" module doc file which has been ignored since 1994.
  ........
    r55522 | mark.hammond | 2007-05-22 19:04:28 -0700 (Tue, 22 May 2007) | 4 lines

    Remove definition of PY_UNICODE_TYPE from pyconfig.h, allowing the
    definition in unicodeobject.h to be used, giving us the desired
    wchar_t in place of 'unsigned short'.  As discussed on python-dev.
  ........
    r55525 | neal.norwitz | 2007-05-22 23:35:32 -0700 (Tue, 22 May 2007) | 6 lines

    Add -3 option to the interpreter to warn about features that are
    deprecated and will be changed/removed in Python 3.0.

    This patch is mostly from Anthony.  I tweaked some format and added
    a little doc.
  ........
    r55527 | neal.norwitz | 2007-05-22 23:57:35 -0700 (Tue, 22 May 2007) | 1 line

    Whitespace cleanup
  ........
    r55528 | neal.norwitz | 2007-05-22 23:58:36 -0700 (Tue, 22 May 2007) | 1 line

    Add a bunch more deprecation warnings for builtins that are going away in 3.0
  ........
    r55549 | georg.brandl | 2007-05-24 09:49:29 -0700 (Thu, 24 May 2007) | 2 lines

    shlex.split() now has an optional "posix" parameter.
  ........
    r55550 | georg.brandl | 2007-05-24 10:33:33 -0700 (Thu, 24 May 2007) | 2 lines

    Fix parameter passing.
  ........
    r55555 | facundo.batista | 2007-05-24 10:50:54 -0700 (Thu, 24 May 2007) | 6 lines


    Added an optional timeout parameter to urllib.ftpwrapper, with tests
    (for this and a basic one, because there weren't any). Changed also
    NEWS, but didn't find documentation for this function, assumed it
    wasn't public...
  ........
    r55563 | facundo.batista | 2007-05-24 13:01:59 -0700 (Thu, 24 May 2007) | 4 lines


    Removed the .recv() in the test, is not necessary, and was
    causing problems that didn't have anything to do with was
    actually being tested...
  ........
    r55564 | facundo.batista | 2007-05-24 13:51:19 -0700 (Thu, 24 May 2007) | 5 lines


    Let's see if reading exactly what is written allow this live
    test to pass (now I know why there were so few tests in ftp,
    http, etc, :( ).
  ........
    r55567 | facundo.batista | 2007-05-24 20:10:28 -0700 (Thu, 24 May 2007) | 4 lines


    Trying to make the tests work in Windows and Solaris, everywhere
    else just works
  ........
    r55568 | facundo.batista | 2007-05-24 20:47:19 -0700 (Thu, 24 May 2007) | 4 lines


    Fixing stupid error, and introducing a sleep, to see if the
    other thread is awakened and finish sending data.
  ........
    r55569 | facundo.batista | 2007-05-24 21:20:22 -0700 (Thu, 24 May 2007) | 4 lines


    Commenting out the tests until find out who can test them in
    one of the problematic enviroments.
  ........
    r55570 | neal.norwitz | 2007-05-24 22:13:40 -0700 (Thu, 24 May 2007) | 2 lines

    Get test passing again by commenting out the reference to the test class.
  ........
    r55575 | vinay.sajip | 2007-05-25 00:05:59 -0700 (Fri, 25 May 2007) | 1 line

    Updated docstring for SysLogHandler (#1720726).
  ........
    r55576 | vinay.sajip | 2007-05-25 00:06:55 -0700 (Fri, 25 May 2007) | 1 line

    Updated documentation for SysLogHandler (#1720726).
  ........
    r55592 | brett.cannon | 2007-05-25 13:17:15 -0700 (Fri, 25 May 2007) | 3 lines

    Remove direct call's to file's constructor and replace them with calls to
    open() as ths is considered best practice.
  ........
    r55601 | kristjan.jonsson | 2007-05-26 12:19:50 -0700 (Sat, 26 May 2007) | 1 line

    Remove the rgbimgmodule from PCBuild8
  ........
    r55602 | kristjan.jonsson | 2007-05-26 12:31:39 -0700 (Sat, 26 May 2007) | 1 line

    Include <windows.h> after python.h, so that WINNT is properly set before windows.h is included.  Fixes warnings in PC builds.
  ........
    r55603 | walter.doerwald | 2007-05-26 14:04:13 -0700 (Sat, 26 May 2007) | 2 lines

    Fix typo.
  ........
    r55604 | peter.astrand | 2007-05-26 15:18:20 -0700 (Sat, 26 May 2007) | 1 line

    Applied patch 1669481, slightly modified: Support close_fds on Win32
  ........
    r55606 | neal.norwitz | 2007-05-26 21:08:54 -0700 (Sat, 26 May 2007) | 2 lines

    Add the new function object attribute names from py3k.
  ........
    r55617 | lars.gustaebel | 2007-05-27 12:49:30 -0700 (Sun, 27 May 2007) | 20 lines

    Added errors argument to TarFile class that allows the user to
    specify an error handling scheme for character conversion. Additional
    scheme "utf-8" in read mode. Unicode input filenames are now
    supported by design. The values of the pax_headers dictionary are now
    limited to unicode objects.

    Fixed: The prefix field is no longer used in PAX_FORMAT (in
    conformance with POSIX).
    Fixed: In read mode use a possible pax header size field.
    Fixed: Strip trailing slashes from pax header name values.
    Fixed: Give values in user-specified pax_headers precedence when
    writing.

    Added unicode tests. Added pax/regtype4 member to testtar.tar all
    possible number fields in a pax header.

    Added two chapters to the documentation about the different formats
    tarfile.py supports and how unicode issues are handled.
  ........
    r55618 | raymond.hettinger | 2007-05-27 22:23:22 -0700 (Sun, 27 May 2007) | 1 line

    Explain when groupby() issues a new group.
  ........
    r55634 | martin.v.loewis | 2007-05-28 21:01:29 -0700 (Mon, 28 May 2007) | 2 lines

    Test pre-commit hook for a link to a .py file.
  ........
    r55635 | martin.v.loewis | 2007-05-28 21:02:03 -0700 (Mon, 28 May 2007) | 2 lines

    Revert 55634.
  ........
................
  r55639 | neal.norwitz | 2007-05-29 00:58:11 -0700 (Tue, 29 May 2007) | 1 line

  Remove sys.exc_{type,exc_value,exc_traceback}
................
  r55641 | neal.norwitz | 2007-05-29 01:03:50 -0700 (Tue, 29 May 2007) | 1 line

  Missed one sys.exc_type.  I wonder why exc_{value,traceback} were already gone
................
  r55642 | neal.norwitz | 2007-05-29 01:08:33 -0700 (Tue, 29 May 2007) | 1 line

  Missed more doc for sys.exc_* attrs.
................
  r55643 | neal.norwitz | 2007-05-29 01:18:19 -0700 (Tue, 29 May 2007) | 1 line

  Remove sys.exc_clear()
................
  r55665 | guido.van.rossum | 2007-05-29 19:45:43 -0700 (Tue, 29 May 2007) | 4 lines

  Make None, True, False keywords.
  We can now also delete all the other places that explicitly forbid
  assignment to None, but I'm not going to bother right now.
................
  r55666 | guido.van.rossum | 2007-05-29 20:01:51 -0700 (Tue, 29 May 2007) | 3 lines

  Found another place that needs check for forbidden names.
  Fixed test_syntax.py accordingly (it helped me find that one).
................
  r55668 | guido.van.rossum | 2007-05-29 20:41:48 -0700 (Tue, 29 May 2007) | 2 lines

  Mark None, True, False as keywords.
................
  r55673 | neal.norwitz | 2007-05-29 23:28:25 -0700 (Tue, 29 May 2007) | 3 lines

  Get the dis module working on modules again after changing dicts
  to not return lists and also new-style classes.  Add a test.
................
  r55674 | neal.norwitz | 2007-05-29 23:35:45 -0700 (Tue, 29 May 2007) | 1 line

  Umm, it helps to add the module that the test uses
................
  r55675 | neal.norwitz | 2007-05-29 23:53:05 -0700 (Tue, 29 May 2007) | 4 lines

  Try to fix up all the other places that were assigning to True/False.
  There's at least one more problem in test.test_xmlrpc.  I have other
  changes in that file and that should be fixed soon (I hope).
................
  r55679 | neal.norwitz | 2007-05-30 00:31:55 -0700 (Wed, 30 May 2007) | 1 line

  Fix up another place that was assigning to True/False.
................
  r55688 | brett.cannon | 2007-05-30 14:19:47 -0700 (Wed, 30 May 2007) | 2 lines

  Ditch MimeWriter.
................
  r55692 | brett.cannon | 2007-05-30 14:52:00 -0700 (Wed, 30 May 2007) | 2 lines

  Remove the mimify module.
................
  r55707 | guido.van.rossum | 2007-05-31 05:08:45 -0700 (Thu, 31 May 2007) | 2 lines

  Backport the addition of show_code() to dis.py -- it's too handy.
................
  r55708 | guido.van.rossum | 2007-05-31 06:22:57 -0700 (Thu, 31 May 2007) | 7 lines

  Fix a fairly long-standing bug in the check for assignment to None (and other
  keywords, these days).  In 2.5, you could write foo(None=1) without getting
  a SyntaxError (although foo()'s definition would have to use **kwds to avoid
  getting a runtime error complaining about an unknown keyword of course).

  This ought to be backported to 2.5.2 or at least 2.6.
................
  r55724 | brett.cannon | 2007-05-31 19:32:41 -0700 (Thu, 31 May 2007) | 2 lines

  Remove the cfmfile.
................
  r55727 | neal.norwitz | 2007-05-31 22:19:44 -0700 (Thu, 31 May 2007) | 1 line

  Remove reload() builtin.
................
  r55729 | neal.norwitz | 2007-05-31 22:51:30 -0700 (Thu, 31 May 2007) | 59 lines

  Merged revisions 55636-55728 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r55637 | georg.brandl | 2007-05-29 00:16:47 -0700 (Tue, 29 May 2007) | 2 lines

    Fix rst markup.
  ........
    r55638 | neal.norwitz | 2007-05-29 00:51:39 -0700 (Tue, 29 May 2007) | 1 line

    Fix typo in doc
  ........
    r55671 | neal.norwitz | 2007-05-29 21:53:41 -0700 (Tue, 29 May 2007) | 1 line

    Fix indentation (whitespace only).
  ........
    r55676 | thomas.heller | 2007-05-29 23:58:30 -0700 (Tue, 29 May 2007) | 1 line

    Fix compiler warnings.
  ........
    r55677 | thomas.heller | 2007-05-30 00:01:25 -0700 (Wed, 30 May 2007) | 2 lines

    Correct the name of a field in the WIN32_FIND_DATAA and WIN32_FIND_DATAW structures.
    Closes bug #1726026.
  ........
    r55686 | brett.cannon | 2007-05-30 13:46:26 -0700 (Wed, 30 May 2007) | 2 lines

    Have MimeWriter raise a DeprecationWarning as per PEP 4 and its documentation.
  ........
    r55690 | brett.cannon | 2007-05-30 14:48:58 -0700 (Wed, 30 May 2007) | 3 lines

    Have mimify raise a DeprecationWarning.  The docs and PEP 4 have listed the
    module as deprecated for a while.
  ........
    r55696 | brett.cannon | 2007-05-30 15:24:28 -0700 (Wed, 30 May 2007) | 2 lines

    Have md5 raise a DeprecationWarning as per PEP 4.
  ........
    r55705 | neal.norwitz | 2007-05-30 21:14:22 -0700 (Wed, 30 May 2007) | 1 line

    Add some spaces in the example code.
  ........
    r55716 | brett.cannon | 2007-05-31 12:20:00 -0700 (Thu, 31 May 2007) | 2 lines

    Have the sha module raise a DeprecationWarning as specified in PEP 4.
  ........
    r55719 | brett.cannon | 2007-05-31 12:40:42 -0700 (Thu, 31 May 2007) | 2 lines

    Cause buildtools to raise a DeprecationWarning.
  ........
    r55721 | brett.cannon | 2007-05-31 13:01:11 -0700 (Thu, 31 May 2007) | 2 lines

    Have cfmfile raise a DeprecationWarning as per PEP 4.
  ........
    r55726 | neal.norwitz | 2007-05-31 21:56:47 -0700 (Thu, 31 May 2007) | 1 line

    Mail if there is an installation failure.
  ........
................
  r55730 | neal.norwitz | 2007-05-31 23:22:07 -0700 (Thu, 31 May 2007) | 2 lines

  Remove the code that was missed in rev 55303.
................
  r55738 | neal.norwitz | 2007-06-01 19:10:43 -0700 (Fri, 01 Jun 2007) | 1 line

  Fix doc breakage
................
  r55741 | neal.norwitz | 2007-06-02 00:41:58 -0700 (Sat, 02 Jun 2007) | 1 line

  Remove timing module (plus some remnants of other modules).
................
  r55742 | neal.norwitz | 2007-06-02 00:51:44 -0700 (Sat, 02 Jun 2007) | 1 line

  Remove posixfile module (plus some remnants of other modules).
................
  r55744 | neal.norwitz | 2007-06-02 10:18:56 -0700 (Sat, 02 Jun 2007) | 1 line

  Fix doc breakage.
................
  r55745 | neal.norwitz | 2007-06-02 11:32:16 -0700 (Sat, 02 Jun 2007) | 1 line

  Make a whatsnew 3.0 template.
................
  r55754 | neal.norwitz | 2007-06-03 23:24:18 -0700 (Sun, 03 Jun 2007) | 1 line

  SF #1730441, os._execvpe raises UnboundLocal due to new try/except semantics
................
  r55755 | neal.norwitz | 2007-06-03 23:26:00 -0700 (Sun, 03 Jun 2007) | 1 line

  Get rid of extra whitespace
................
  r55794 | guido.van.rossum | 2007-06-06 15:29:22 -0700 (Wed, 06 Jun 2007) | 3 lines

  Make this compile in GCC 2.96, which does not allow interspersing
  declarations and code.
................
2007-06-06 23:52:48 +00:00

736 lines
23 KiB
Makefile

# Makefile for Python documentation
# ---------------------------------
#
# See also the README file.
#
# This is a bit of a mess. The documents are identified by short names:
# api -- Python/C API Reference Manual
# doc -- Documenting Python
# ext -- Extending and Embedding the Python Interpreter
# lib -- Library Reference Manual
# mac -- Macintosh Library Modules
# ref -- Python Reference Manual
# tut -- Python Tutorial
# inst -- Installing Python Modules
# dist -- Distributing Python Modules
#
# The LaTeX sources for each of these documents are in subdirectories
# with the three-letter designations above as the directory names.
#
# The main target creates HTML for each of the documents. You can
# also do "make lib" (etc.) to create the HTML versions of individual
# documents.
#
# The document classes and styles are in the texinputs/ directory.
# These define a number of macros that are similar in name and intent
# as macros in Texinfo (e.g. \code{...} and \emph{...}), as well as a
# number of environments for formatting function and data definitions.
# Documentation for the macros is included in "Documenting Python"; see
# http://www.python.org/doc/current/doc/doc.html, or the sources for
# this document in the doc/ directory.
#
# Everything is processed by LaTeX. See the file `README' for more
# information on the tools needed for processing.
#
# There's a problem with generating the index which has been solved by
# a sed command applied to the index file. The shell script fix_hack
# does this (the Makefile takes care of calling it).
#
# Additional targets attempt to convert selected LaTeX sources to
# various other formats. These are generally site specific because
# the tools used are all but universal. These targets are:
#
# ps -- convert all documents from LaTeX to PostScript
# pdf -- convert all documents from LaTeX to the
# Portable Document Format
#
# See the README file for more information on these targets.
#
# The formatted output is located in subdirectories. For PDF and
# PostScript, look in the paper-$(PAPER)/ directory. For HTML, look in
# the html/ directory. If you want to fix the GNU info process, look
# in the info/ directory; please send patches to docs@python.org.
# This Makefile only includes information on how to perform builds; for
# dependency information, see Makefile.deps.
# Customization -- you *may* have to edit this
# You could set this to a4:
PAPER=letter
# Ideally, you shouldn't need to edit beyond this point
INFODIR= info
TOOLSDIR= tools
# This is the *documentation* release, and is used to construct the
# file names of the downloadable tarballs. It is initialized by the
# getversioninfo script to ensure that the right version number is
# used; the script will also write commontex/patchlevel.tex if that
# doesn't exist or needs to be changed. Documents which depend on the
# version number should use \input{patchlevel} and include
# commontex/patchlevel.tex in their dependencies.
RELEASE=$(shell $(PYTHON) tools/getversioninfo)
PYTHON= $(PWD)/../python
DVIPS= dvips -N0 -t $(PAPER)
# This is ugly! The issue here is that there are two different levels
# in the directory tree at which we execute mkhowto, so we can't
# define it just once using a relative path (at least not with the
# current implementation and Makefile structure). We use the GNUish
# $(shell) function here to work around that restriction by
# identifying mkhowto and the commontex/ directory using absolute paths.
#
# If your doc build fails immediately, you may need to switch to GNU make.
# (e.g. OpenBSD needs package gmake installed; use gmake instead of make)
PWD=$(shell pwd)
# (The trailing colon in the value is needed; TeX places its default
# set of paths at the location of the empty string in the path list.)
TEXINPUTS=$(PWD)/commontex:
# The mkhowto script can be run from the checkout using the first
# version of this variable definition, or from a preferred version
# using the second version. The standard documentation is typically
# built using the second flavor, where the preferred version is from
# the Python CVS trunk.
MKHOWTO= TEXINPUTS=$(TEXINPUTS) $(PYTHON) $(PWD)/tools/mkhowto
MKDVI= $(MKHOWTO) --paper=$(PAPER) --dvi
MKHTML= $(MKHOWTO) --html --about html/stdabout.dat \
--iconserver ../icons --favicon ../icons/pyfav.png \
--address $(PYTHONDOCS) --up-link ../index.html \
--up-title "Python Documentation Index" \
--global-module-index "../modindex.html" --dvips-safe
MKISILOHTML=$(MKHOWTO) --html --about html/stdabout.dat \
--iconserver ../icons \
--l2h-init perl/isilo.perl --numeric --split 1 \
--dvips-safe
MKISILO= iSilo386 -U -y -rCR -d0
MKPDF= $(MKHOWTO) --paper=$(PAPER) --pdf
MKPS= $(MKHOWTO) --paper=$(PAPER) --ps
BUILDINDEX=$(TOOLSDIR)/buildindex.py
PYTHONDOCS="See <i><a href=\"about.html\">About this document...</a></i> for information on suggesting changes."
HTMLBASE= file:`pwd`
# The emacs binary used to build the info docs. GNU Emacs 21 is required.
EMACS= emacs
# The end of this should reflect the major/minor version numbers of
# the release:
WHATSNEW=whatsnew30
# what's what
MANDVIFILES= paper-$(PAPER)/api.dvi paper-$(PAPER)/ext.dvi \
paper-$(PAPER)/lib.dvi paper-$(PAPER)/mac.dvi \
paper-$(PAPER)/ref.dvi paper-$(PAPER)/tut.dvi
HOWTODVIFILES= paper-$(PAPER)/doc.dvi paper-$(PAPER)/inst.dvi \
paper-$(PAPER)/dist.dvi paper-$(PAPER)/$(WHATSNEW).dvi
MANPDFFILES= paper-$(PAPER)/api.pdf paper-$(PAPER)/ext.pdf \
paper-$(PAPER)/lib.pdf paper-$(PAPER)/mac.pdf \
paper-$(PAPER)/ref.pdf paper-$(PAPER)/tut.pdf
HOWTOPDFFILES= paper-$(PAPER)/doc.pdf paper-$(PAPER)/inst.pdf \
paper-$(PAPER)/dist.pdf paper-$(PAPER)/$(WHATSNEW).pdf
MANPSFILES= paper-$(PAPER)/api.ps paper-$(PAPER)/ext.ps \
paper-$(PAPER)/lib.ps paper-$(PAPER)/mac.ps \
paper-$(PAPER)/ref.ps paper-$(PAPER)/tut.ps
HOWTOPSFILES= paper-$(PAPER)/doc.ps paper-$(PAPER)/inst.ps \
paper-$(PAPER)/dist.ps paper-$(PAPER)/$(WHATSNEW).ps
DVIFILES= $(MANDVIFILES) $(HOWTODVIFILES)
PDFFILES= $(MANPDFFILES) $(HOWTOPDFFILES)
PSFILES= $(MANPSFILES) $(HOWTOPSFILES)
HTMLCSSFILES=html/api/api.css \
html/doc/doc.css \
html/ext/ext.css \
html/lib/lib.css \
html/mac/mac.css \
html/ref/ref.css \
html/tut/tut.css \
html/inst/inst.css \
html/dist/dist.css
ISILOCSSFILES=isilo/api/api.css \
isilo/doc/doc.css \
isilo/ext/ext.css \
isilo/lib/lib.css \
isilo/mac/mac.css \
isilo/ref/ref.css \
isilo/tut/tut.css \
isilo/inst/inst.css \
isilo/dist/dist.css
ALLCSSFILES=$(HTMLCSSFILES) $(ISILOCSSFILES)
INDEXFILES=html/api/api.html \
html/doc/doc.html \
html/ext/ext.html \
html/lib/lib.html \
html/mac/mac.html \
html/ref/ref.html \
html/tut/tut.html \
html/inst/inst.html \
html/dist/dist.html \
html/whatsnew/$(WHATSNEW).html
ALLHTMLFILES=$(INDEXFILES) html/index.html html/modindex.html html/acks.html
COMMONPERL= perl/manual.perl perl/python.perl perl/l2hinit.perl
ANNOAPI=api/refcounts.dat tools/anno-api.py
include Makefile.deps
# These must be declared phony since there
# are directories with matching names:
.PHONY: api doc ext lib mac ref tut inst dist
.PHONY: html info isilo
# Main target
default: html
all: html dvi ps pdf isilo
dvi: $(DVIFILES)
pdf: $(PDFFILES)
ps: $(PSFILES)
world: ps pdf html distfiles
# Rules to build PostScript and PDF formats
.SUFFIXES: .dvi .ps
.dvi.ps:
$(DVIPS) -o $@ $<
# Targets for each document:
# Python/C API Reference Manual
paper-$(PAPER)/api.dvi: $(ANNOAPIFILES)
cd paper-$(PAPER) && $(MKDVI) api.tex
paper-$(PAPER)/api.pdf: $(ANNOAPIFILES)
cd paper-$(PAPER) && $(MKPDF) api.tex
paper-$(PAPER)/api.tex: api/api.tex
cp api/api.tex $@
paper-$(PAPER)/abstract.tex: api/abstract.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/abstract.tex
paper-$(PAPER)/concrete.tex: api/concrete.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/concrete.tex
paper-$(PAPER)/exceptions.tex: api/exceptions.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/exceptions.tex
paper-$(PAPER)/init.tex: api/init.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/init.tex
paper-$(PAPER)/intro.tex: api/intro.tex
cp api/intro.tex $@
paper-$(PAPER)/memory.tex: api/memory.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/memory.tex
paper-$(PAPER)/newtypes.tex: api/newtypes.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/newtypes.tex
paper-$(PAPER)/refcounting.tex: api/refcounting.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/refcounting.tex
paper-$(PAPER)/utilities.tex: api/utilities.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/utilities.tex
paper-$(PAPER)/veryhigh.tex: api/veryhigh.tex $(ANNOAPI)
$(PYTHON) $(TOOLSDIR)/anno-api.py -o $@ api/veryhigh.tex
# Distributing Python Modules
paper-$(PAPER)/dist.dvi: $(DISTFILES)
cd paper-$(PAPER) && $(MKDVI) ../dist/dist.tex
paper-$(PAPER)/dist.pdf: $(DISTFILES)
cd paper-$(PAPER) && $(MKPDF) ../dist/dist.tex
# Documenting Python
paper-$(PAPER)/doc.dvi: $(DOCFILES)
cd paper-$(PAPER) && $(MKDVI) ../doc/doc.tex
paper-$(PAPER)/doc.pdf: $(DOCFILES)
cd paper-$(PAPER) && $(MKPDF) ../doc/doc.tex
# Extending and Embedding the Python Interpreter
paper-$(PAPER)/ext.dvi: $(EXTFILES)
cd paper-$(PAPER) && $(MKDVI) ../ext/ext.tex
paper-$(PAPER)/ext.pdf: $(EXTFILES)
cd paper-$(PAPER) && $(MKPDF) ../ext/ext.tex
# Installing Python Modules
paper-$(PAPER)/inst.dvi: $(INSTFILES)
cd paper-$(PAPER) && $(MKDVI) ../inst/inst.tex
paper-$(PAPER)/inst.pdf: $(INSTFILES)
cd paper-$(PAPER) && $(MKPDF) ../inst/inst.tex
# Python Library Reference
paper-$(PAPER)/lib.dvi: $(LIBFILES)
cd paper-$(PAPER) && $(MKDVI) ../lib/lib.tex
paper-$(PAPER)/lib.pdf: $(LIBFILES)
cd paper-$(PAPER) && $(MKPDF) ../lib/lib.tex
# Macintosh Library Modules
paper-$(PAPER)/mac.dvi: $(MACFILES)
cd paper-$(PAPER) && $(MKDVI) ../mac/mac.tex
paper-$(PAPER)/mac.pdf: $(MACFILES)
cd paper-$(PAPER) && $(MKPDF) ../mac/mac.tex
# Python Reference Manual
paper-$(PAPER)/ref.dvi: $(REFFILES)
cd paper-$(PAPER) && $(MKDVI) ../ref/ref.tex
paper-$(PAPER)/ref.pdf: $(REFFILES)
cd paper-$(PAPER) && $(MKPDF) ../ref/ref.tex
# Python Tutorial
paper-$(PAPER)/tut.dvi: $(TUTFILES)
cd paper-$(PAPER) && $(MKDVI) ../tut/tut.tex
paper-$(PAPER)/tut.pdf: $(TUTFILES)
cd paper-$(PAPER) && $(MKPDF) ../tut/tut.tex
# What's New in Python X.Y
paper-$(PAPER)/$(WHATSNEW).dvi: whatsnew/$(WHATSNEW).tex
cd paper-$(PAPER) && $(MKDVI) ../whatsnew/$(WHATSNEW).tex
paper-$(PAPER)/$(WHATSNEW).pdf: whatsnew/$(WHATSNEW).tex
cd paper-$(PAPER) && $(MKPDF) ../whatsnew/$(WHATSNEW).tex
# The remaining part of the Makefile is concerned with various
# conversions, as described above. See also the README file.
info:
cd $(INFODIR) && $(MAKE) EMACS=$(EMACS) WHATSNEW=$(WHATSNEW)
# Targets to convert the manuals to HTML using Nikos Drakos' LaTeX to
# HTML converter. For more info on this program, see
# <URL:http://cbl.leeds.ac.uk/nikos/tex2html/doc/latex2html/latex2html.html>.
# Note that LaTeX2HTML inserts references to an icons directory in
# each page that it generates. I have placed a copy of this directory
# in the distribution to simplify the process of creating a
# self-contained HTML distribution; for this purpose I have also added
# a (trivial) index.html. Change the definition of $ICONSERVER in
# perl/l2hinit.perl to use a different location for the icons directory.
# If you have the standard LaTeX2HTML icons installed, the versions shipped
# with this documentation should be stored in a separate directory and used
# instead. The standard set does *not* include all the icons used in the
# Python documentation.
$(ALLCSSFILES): html/style.css
cp $< $@
$(INDEXFILES): $(COMMONPERL) html/stdabout.dat tools/node2label.pl
html/acks.html: ACKS $(TOOLSDIR)/support.py $(TOOLSDIR)/mkackshtml
$(PYTHON) $(TOOLSDIR)/mkackshtml --address $(PYTHONDOCS) \
--favicon icons/pyfav.png \
--output html/acks.html <ACKS
# html/index.html is dependent on $(INDEXFILES) since we want the date
# on the front index to be updated whenever any of the child documents
# are updated and boilerplate.tex uses \today as the date. The index
# files are not used to actually generate content.
BOILERPLATE=commontex/boilerplate.tex
html/index.html: $(INDEXFILES)
html/index.html: html/index.html.in $(BOILERPLATE) tools/rewrite.py
$(PYTHON) tools/rewrite.py $(BOILERPLATE) \
RELEASE=$(RELEASE) WHATSNEW=$(WHATSNEW) \
<$< >$@
html/modindex.html: $(TOOLSDIR)/support.py $(TOOLSDIR)/mkmodindex
html/modindex.html: html/dist/dist.html
html/modindex.html: html/lib/lib.html html/mac/mac.html
cd html && \
$(PYTHON) ../$(TOOLSDIR)/mkmodindex --columns 3 \
--output modindex.html --address $(PYTHONDOCS) \
--favicon icons/pyfav.png \
dist/modindex.html \
lib/modindex.html mac/modindex.html
html: $(ALLHTMLFILES) $(HTMLCSSFILES)
api: html/api/api.html html/api/api.css
html/api/api.html: $(APIFILES) api/refcounts.dat
$(MKHTML) --dir html/api api/api.tex
doc: html/doc/doc.html html/doc/doc.css
html/doc/doc.html: $(DOCFILES)
$(MKHTML) --dir html/doc doc/doc.tex
ext: html/ext/ext.html html/ext/ext.css
html/ext/ext.html: $(EXTFILES)
$(MKHTML) --dir html/ext ext/ext.tex
lib: html/lib/lib.html html/lib/lib.css
html/lib/lib.html: $(LIBFILES)
$(MKHTML) --dir html/lib lib/lib.tex
mac: html/mac/mac.html html/mac/mac.css
html/mac/mac.html: $(MACFILES)
$(MKHTML) --dir html/mac mac/mac.tex
ref: html/ref/ref.html html/ref/ref.css
html/ref/ref.html: $(REFFILES)
$(MKHTML) --dir html/ref ref/ref.tex
tut: html/tut/tut.html html/tut/tut.css
html/tut/tut.html: $(TUTFILES)
$(MKHTML) --dir html/tut --numeric --split 3 tut/tut.tex
inst: html/inst/inst.html html/inst/inst.css
html/inst/inst.html: $(INSTFILES) perl/distutils.perl
$(MKHTML) --dir html/inst --split 4 inst/inst.tex
dist: html/dist/dist.html html/dist/dist.css
html/dist/dist.html: $(DISTFILES) perl/distutils.perl
$(MKHTML) --dir html/dist --split 4 dist/dist.tex
whatsnew: html/whatsnew/$(WHATSNEW).html
html/whatsnew/$(WHATSNEW).html: whatsnew/$(WHATSNEW).tex
$(MKHTML) --dir html/whatsnew --split 4 whatsnew/$(WHATSNEW).tex
# The iSilo format is used by the iSilo document reader for PalmOS devices.
ISILOINDEXFILES=isilo/api/api.html \
isilo/doc/doc.html \
isilo/ext/ext.html \
isilo/lib/lib.html \
isilo/mac/mac.html \
isilo/ref/ref.html \
isilo/tut/tut.html \
isilo/inst/inst.html \
isilo/dist/dist.html \
isilo/whatsnew/$(WHATSNEW).html
$(ISILOINDEXFILES): $(COMMONPERL) html/stdabout.dat perl/isilo.perl
isilo: isilo/python-api.pdb \
isilo/python-doc.pdb \
isilo/python-ext.pdb \
isilo/python-lib.pdb \
isilo/python-mac.pdb \
isilo/python-ref.pdb \
isilo/python-tut.pdb \
isilo/python-dist.pdb \
isilo/python-inst.pdb \
isilo/python-whatsnew.pdb
isilo/python-api.pdb: isilo/api/api.html isilo/api/api.css
$(MKISILO) "-iPython/C API Reference Manual" \
isilo/api/api.html $@
isilo/python-doc.pdb: isilo/doc/doc.html isilo/doc/doc.css
$(MKISILO) "-iDocumenting Python" \
isilo/doc/doc.html $@
isilo/python-ext.pdb: isilo/ext/ext.html isilo/ext/ext.css
$(MKISILO) "-iExtending & Embedding Python" \
isilo/ext/ext.html $@
isilo/python-lib.pdb: isilo/lib/lib.html isilo/lib/lib.css
$(MKISILO) "-iPython Library Reference" \
isilo/lib/lib.html $@
isilo/python-mac.pdb: isilo/mac/mac.html isilo/mac/mac.css
$(MKISILO) "-iPython/C API Reference Manual" \
isilo/mac/mac.html $@
isilo/python-ref.pdb: isilo/ref/ref.html isilo/ref/ref.css
$(MKISILO) "-iPython Reference Manual" \
isilo/ref/ref.html $@
isilo/python-tut.pdb: isilo/tut/tut.html isilo/tut/tut.css
$(MKISILO) "-iPython Tutorial" \
isilo/tut/tut.html $@
isilo/python-dist.pdb: isilo/dist/dist.html isilo/dist/dist.css
$(MKISILO) "-iDistributing Python Modules" \
isilo/dist/dist.html $@
isilo/python-inst.pdb: isilo/inst/inst.html isilo/inst/inst.css
$(MKISILO) "-iInstalling Python Modules" \
isilo/inst/inst.html $@
isilo/python-whatsnew.pdb: isilo/whatsnew/$(WHATSNEW).html isilo/whatsnew/$(WHATSNEW).css
$(MKISILO) "-iWhat's New in Python X.Y" \
isilo/whatsnew/$(WHATSNEW).html $@
isilo/api/api.html: $(APIFILES) api/refcounts.dat
$(MKISILOHTML) --dir isilo/api api/api.tex
isilo/doc/doc.html: $(DOCFILES)
$(MKISILOHTML) --dir isilo/doc doc/doc.tex
isilo/ext/ext.html: $(EXTFILES)
$(MKISILOHTML) --dir isilo/ext ext/ext.tex
isilo/lib/lib.html: $(LIBFILES)
$(MKISILOHTML) --dir isilo/lib lib/lib.tex
isilo/mac/mac.html: $(MACFILES)
$(MKISILOHTML) --dir isilo/mac mac/mac.tex
isilo/ref/ref.html: $(REFFILES)
$(MKISILOHTML) --dir isilo/ref ref/ref.tex
isilo/tut/tut.html: $(TUTFILES)
$(MKISILOHTML) --dir isilo/tut tut/tut.tex
isilo/inst/inst.html: $(INSTFILES) perl/distutils.perl
$(MKISILOHTML) --dir isilo/inst inst/inst.tex
isilo/dist/dist.html: $(DISTFILES) perl/distutils.perl
$(MKISILOHTML) --dir isilo/dist dist/dist.tex
isilo/whatsnew/$(WHATSNEW).html: whatsnew/$(WHATSNEW).tex
$(MKISILOHTML) --dir isilo/whatsnew whatsnew/$(WHATSNEW).tex
# These are useful if you need to transport the iSilo-ready HTML to
# another machine to perform the conversion:
isilozip: isilo-html-$(RELEASE).zip
isilo-html-$(RELEASE).zip: $(ISILOINDEXFILES)
rm -f $@
cd isilo && \
zip -q -9 ../$@ */*.css */*.html */*.txt
# webchecker needs an extra flag to process the huge index from the libref
WEBCHECKER=$(PYTHON) ../Tools/webchecker/webchecker.py
HTMLBASE= file:`pwd`/html
webcheck: $(ALLHTMLFILES)
$(WEBCHECKER) $(HTMLBASE)/api/
$(WEBCHECKER) $(HTMLBASE)/doc/
$(WEBCHECKER) $(HTMLBASE)/ext/
$(WEBCHECKER) -m290000 $(HTMLBASE)/lib/
$(WEBCHECKER) $(HTMLBASE)/mac/
$(WEBCHECKER) $(HTMLBASE)/ref/
$(WEBCHECKER) $(HTMLBASE)/tut/
$(WEBCHECKER) $(HTMLBASE)/dist/
$(WEBCHECKER) $(HTMLBASE)/inst/
$(WEBCHECKER) $(HTMLBASE)/whatsnew/
fastwebcheck: $(ALLHTMLFILES)
$(WEBCHECKER) -x $(HTMLBASE)/api/
$(WEBCHECKER) -x $(HTMLBASE)/doc/
$(WEBCHECKER) -x $(HTMLBASE)/ext/
$(WEBCHECKER) -x -m290000 $(HTMLBASE)/lib/
$(WEBCHECKER) -x $(HTMLBASE)/mac/
$(WEBCHECKER) -x $(HTMLBASE)/ref/
$(WEBCHECKER) -x $(HTMLBASE)/tut/
$(WEBCHECKER) -x $(HTMLBASE)/dist/
$(WEBCHECKER) -x $(HTMLBASE)/inst/
$(WEBCHECKER) -x $(HTMLBASE)/whatsnew/
# Release packaging targets:
paper-$(PAPER)/README: $(PSFILES) $(TOOLSDIR)/getpagecounts
cd paper-$(PAPER) && ../$(TOOLSDIR)/getpagecounts -r $(RELEASE) >../$@
info-$(RELEASE).tgz: info
cd $(INFODIR) && tar cf - README python.dir python-*.info* \
| gzip -9 >../$@
info-$(RELEASE).tar.bz2: info
cd $(INFODIR) && tar cf - README python.dir python-*.info* \
| bzip2 -9 >../$@
latex-$(RELEASE).tgz:
$(PYTHON) $(TOOLSDIR)/mksourcepkg --gzip $(RELEASE)
latex-$(RELEASE).tar.bz2:
$(PYTHON) $(TOOLSDIR)/mksourcepkg --bzip2 $(RELEASE)
latex-$(RELEASE).zip:
rm -f $@
$(PYTHON) $(TOOLSDIR)/mksourcepkg --zip $(RELEASE)
pdf-$(PAPER)-$(RELEASE).tar: $(PDFFILES)
rm -f $@
mkdir Python-Docs-$(RELEASE)
cp paper-$(PAPER)/*.pdf Python-Docs-$(RELEASE)
tar cf $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
pdf-$(PAPER)-$(RELEASE).tgz: pdf-$(PAPER)-$(RELEASE).tar
gzip -9 <$? >$@
pdf-$(PAPER)-$(RELEASE).tar.bz2: pdf-$(PAPER)-$(RELEASE).tar
bzip2 -9 <$? >$@
pdf-$(PAPER)-$(RELEASE).zip: pdf
rm -f $@
mkdir Python-Docs-$(RELEASE)
cp paper-$(PAPER)/*.pdf Python-Docs-$(RELEASE)
zip -q -r -9 $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
postscript-$(PAPER)-$(RELEASE).tar: $(PSFILES) paper-$(PAPER)/README
rm -f $@
mkdir Python-Docs-$(RELEASE)
cp paper-$(PAPER)/*.ps Python-Docs-$(RELEASE)
cp paper-$(PAPER)/README Python-Docs-$(RELEASE)
tar cf $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
postscript-$(PAPER)-$(RELEASE).tar.bz2: postscript-$(PAPER)-$(RELEASE).tar
bzip2 -9 <$< >$@
postscript-$(PAPER)-$(RELEASE).tgz: postscript-$(PAPER)-$(RELEASE).tar
gzip -9 <$< >$@
postscript-$(PAPER)-$(RELEASE).zip: $(PSFILES) paper-$(PAPER)/README
rm -f $@
mkdir Python-Docs-$(RELEASE)
cp paper-$(PAPER)/*.ps Python-Docs-$(RELEASE)
cp paper-$(PAPER)/README Python-Docs-$(RELEASE)
zip -q -r -9 $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
HTMLPKGFILES=*.html */*.css */*.html */*.gif */*.png */*.txt
html-$(RELEASE).tar: $(ALLHTMLFILES) $(HTMLCSSFILES)
mkdir Python-Docs-$(RELEASE)
-find html -name '*.gif' -size 0 | xargs rm -f
cd html && tar cf ../temp.tar $(HTMLPKGFILES)
cd Python-Docs-$(RELEASE) && tar xf ../temp.tar
rm temp.tar
tar cf html-$(RELEASE).tar Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
html-$(RELEASE).tgz: html-$(RELEASE).tar
gzip -9 <$? >$@
html-$(RELEASE).tar.bz2: html-$(RELEASE).tar
bzip2 -9 <$? >$@
html-$(RELEASE).zip: $(ALLHTMLFILES) $(HTMLCSSFILES)
rm -f $@
mkdir Python-Docs-$(RELEASE)
cd html && tar cf ../temp.tar $(HTMLPKGFILES)
cd Python-Docs-$(RELEASE) && tar xf ../temp.tar
rm temp.tar
zip -q -r -9 $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
isilo-$(RELEASE).zip: isilo
rm -f $@
mkdir Python-Docs-$(RELEASE)
cp isilo/python-*.pdb Python-Docs-$(RELEASE)
zip -q -r -9 $@ Python-Docs-$(RELEASE)
rm -r Python-Docs-$(RELEASE)
# convenience targets:
tarhtml: html-$(RELEASE).tgz
tarinfo: info-$(RELEASE).tgz
tarps: postscript-$(PAPER)-$(RELEASE).tgz
tarpdf: pdf-$(PAPER)-$(RELEASE).tgz
tarlatex: latex-$(RELEASE).tgz
tarballs: tarpdf tarps tarhtml
ziphtml: html-$(RELEASE).zip
zipps: postscript-$(PAPER)-$(RELEASE).zip
zippdf: pdf-$(PAPER)-$(RELEASE).zip
ziplatex: latex-$(RELEASE).zip
zipisilo: isilo-$(RELEASE).zip
zips: zippdf zipps ziphtml
bziphtml: html-$(RELEASE).tar.bz2
bzipinfo: info-$(RELEASE).tar.bz2
bzipps: postscript-$(PAPER)-$(RELEASE).tar.bz2
bzippdf: pdf-$(PAPER)-$(RELEASE).tar.bz2
bziplatex: latex-$(RELEASE).tar.bz2
bzips: bzippdf bzipps bziphtml
disthtml: bziphtml ziphtml
distinfo: bzipinfo
distps: bzipps zipps
distpdf: bzippdf zippdf
distlatex: bziplatex ziplatex
# We use the "pkglist" target at the end of these to ensure the
# package list is updated after building either of these; this seems a
# reasonable compromise between only building it for distfiles or
# having to build it manually. Doing it here allows the packages for
# distribution to be built using either of
# make distfiles && make PAPER=a4 paperdist
# make paperdist && make PAPER=a4 distfiles
# The small amount of additional work is a small price to pay for not
# having to remember which order to do it in. ;)
paperdist: distpdf distps pkglist
edist: disthtml pkglist
# The pkglist.html file is used as part of the download.html page on
# python.org; it is not used as intermediate input here or as part of
# the packages created.
pkglist:
$(TOOLSDIR)/mkpkglist >pkglist.html
distfiles: paperdist edist
$(TOOLSDIR)/mksourcepkg --bzip2 --zip $(RELEASE)
$(TOOLSDIR)/mkpkglist >pkglist.html
# Housekeeping targets
# Remove temporary files; all except the following:
# - sources: .tex, .bib, .sty, *.cls
# - useful results: .dvi, .pdf, .ps, .texi, .info
clean:
rm -f html-$(RELEASE).tar
cd $(INFODIR) && $(MAKE) clean
# Remove temporaries as well as final products
clobber:
rm -f html-$(RELEASE).tar
rm -f html-$(RELEASE).tgz info-$(RELEASE).tgz
rm -f pdf-$(RELEASE).tgz postscript-$(RELEASE).tgz
rm -f latex-$(RELEASE).tgz html-$(RELEASE).zip
rm -f pdf-$(RELEASE).zip postscript-$(RELEASE).zip
rm -f $(DVIFILES) $(PSFILES) $(PDFFILES)
cd $(INFODIR) && $(MAKE) clobber
rm -f paper-$(PAPER)/*.tex paper-$(PAPER)/*.ind paper-$(PAPER)/*.idx
rm -f paper-$(PAPER)/*.l2h paper-$(PAPER)/*.how paper-$(PAPER)/README
rm -rf html/index.html html/modindex.html html/acks.html
rm -rf html/api/ html/doc/ html/ext/ html/lib/ html/mac/
rm -rf html/ref/ html/tut/ html/inst/ html/dist/
rm -rf html/whatsnew/
rm -rf isilo/api/ isilo/doc/ isilo/ext/ isilo/lib/ isilo/mac/
rm -rf isilo/ref/ isilo/tut/ isilo/inst/ isilo/dist/
rm -rf isilo/whatsnew/
rm -f isilo/python-*.pdb isilo-$(RELEASE).zip
realclean distclean: clobber