cpython-lru_cache-weakref: Doc/README annotate

annotate Doc/README @ 25838:8540887bcec6 2.2

Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.

author	Guido van Rossum <guido@python.org>
date	Fri, 18 Oct 2002 13:42:21 +0000
parents	1087ca519eb9
children	12a7f2156481 865a77ce40a9

rev	line source
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	1 Python standard documentation -- in LaTeX
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	2 -----------------------------------------
796 136061840624 Made ready for release Guido van Rossum <guido@python.org> parents: 698 diff changeset	3
8980 f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	4 This directory contains the LaTeX sources to the Python documentation
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	5 and tools required to support the formatting process. The documents
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	6 now require LaTeX2e; LaTeX 2.09 compatibility has been dropped.
667 164b56fa6558 Added ref and qua; forget about the Makefile Guido van Rossum <guido@python.org> parents: 432 diff changeset	7
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	8 If you don't have LaTeX, or if you'd rather not format the
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	9 documentation yourself, you can ftp a tar file containing HTML, PDF,
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	10 or PostScript versions of all documents. Additional formats may be
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	11 available. These should be in the same place where you fetched the
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	12 main Python distribution (try <http://www.python.org/> or
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	13 <ftp://ftp.python.org/pub/python/>).
2583 7914915729e3 adapted to modern times; added section of HTML Guido van Rossum <guido@python.org> parents: 1751 diff changeset	14
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	15 The following are the LaTeX source files:
0 3cd033e6b530 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	16
8291 f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	17 api/*.tex Python/C API Reference Manual
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	18 doc/*.tex Documenting Python
8291 f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	19 ext/*.tex Extending and Embedding the Python Interpreter
f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	20 lib/*.tex Python Library Reference
8980 f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	21 mac/*.tex Macintosh Library Modules
8291 f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	22 ref/*.tex Python Reference Manual
f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	23 tut/*.tex Python Tutorial
12523 019eaef637ff Added 'inst' and 'dist' -- the two Distutils manuals. Greg Ward <gward@python.net> parents: 12238 diff changeset	24 inst/*.tex Installing Python Modules
019eaef637ff Added 'inst' and 'dist' -- the two Distutils manuals. Greg Ward <gward@python.net> parents: 12238 diff changeset	25 dist/*.tex Distributing Python Modules
0 3cd033e6b530 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	26
8980 f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	27 Most use the "manual" document class and "python" package, derived from
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	28 the old "myformat.sty" style file. The Macintosh Library Modules
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	29 document uses the "howto" document class instead. These contains many
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	30 macro definitions useful in documenting Python, and set some style
f1e41fc2783c Some minor updates. Fred Drake <fdrake@acm.org> parents: 8945 diff changeset	31 parameters.
796 136061840624 Made ready for release Guido van Rossum <guido@python.org> parents: 698 diff changeset	32
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	33 There's a Makefile to call LaTeX and the other utilities in the right
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	34 order and the right number of times. By default, it will build the
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	35 HTML version of the documnetation, but DVI, PDF, and PostScript can
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	36 also be made. To view the generated HTML, point your favorite browser
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	37 at the top-level index (html/index.html) after running "make".
2583 7914915729e3 adapted to modern times; added section of HTML Guido van Rossum <guido@python.org> parents: 1751 diff changeset	38
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	39 The Makefile can also produce DVI files for each document made; to
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	40 preview them, use xdvi. PostScript is produced by the same Makefile
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	41 target that produces the DVI files. This uses the dvips tool.
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	42 Printing depends on local conventions; at our site, we use lpr. For
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	43 example:
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	44
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	45 make paper-letter/lib.ps # create lib.dvi and lib.ps
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	46 xdvi paper-letter/lib.dvi # preview lib.dvi
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	47 lpr paper-letter/lib.ps # print on default printer
2583 7914915729e3 adapted to modern times; added section of HTML Guido van Rossum <guido@python.org> parents: 1751 diff changeset	48
0 3cd033e6b530 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	49
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	50 What if I find a bug?
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	51 ---------------------
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	52
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	53 First, check that the bug is present in the development version of the
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	54 documentation at <http://python.sourceforge.net/devel-docs/>; we may
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	55 have already fixed it.
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	56
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	57 If we haven't, tell us about it. We'd like the documentation to be
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	58 complete and accurate, but have limited time. If you discover any
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	59 inconsistencies between the documentation and implementation, or just
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	60 have suggestions as to how to improve the documentation, let is know!
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	61 Specific bugs and patches should be reported using our bug & patch
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	62 databases at:
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	63
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	64 http://sourceforge.net/projects/python
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	65
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	66 Other suggestions or questions should be sent to the Python
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	67 Documentation Team:
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	68
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	69 python-docs@python.org
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	70
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	71 Thanks!
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	72
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	73
8301 8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	74 What happened to the Macintosh chapter of the Python Library Reference?
8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	75 -----------------------------------------------------------------------
8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	76
8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	77 The directory mac/ contains the LaTeX sources for the "Macintosh
8945 7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	78 Library Modules" manual; this is built using the standard build
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	79 targets, so check the proper output directory for your chosen format
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	80 and paper size.
8301 8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	81
8b50751f272c Added a section about documentation for the Mac modules. Fred Drake <fdrake@acm.org> parents: 8291 diff changeset	82
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	83 What tools do I need?
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	84 ---------------------
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	85
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	86 You need to install Python; some of the scripts used to produce the
8945 7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	87 documentation are written in Python. You don't need this
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	88 documentation to install Python; instructions are included in the
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	89 README file in the Python distribution.
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	90
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	91 The simplest way to get the rest of the tools in the configuration we
14296 8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	92 used is to install the teTeX TeX distribution, versions 0.9 or newer.
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	93 More information is available on teTeX at <http://www.tug.org/tetex/>.
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	94 This is a Unix-only TeX distribution at this time. This documentation
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	95 release was tested with the 1.0.7 release, but there have been no
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	96 substantial changes since late in the 0.9 series, which we used
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	97 extensively for previous versions without any difficulty.
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	98
8291 f8a389b104f0 Changed some comments.... no longer mention FrameMaker. Fred Drake <fdrake@acm.org> parents: 7931 diff changeset	99 If you don't want to get teTeX, here is what you'll need:
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	100
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	101 To create DVI, PDF, or PostScript files:
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	102
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	103 - LaTeX2e, 1995/12/01 or newer. Older versions are likely to
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	104 choke.
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	105
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	106 - makeindex. This is used to produce the indexes for the
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	107 library reference and Python/C API reference.
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	108
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	109 To create PDF files:
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	110
14296 8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	111 - pdflatex. We used the one in the teTeX distribution (pdfTeX
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	112 version 3.14159-13d (Web2C 7.3.1) at the time of this
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	113 writing). Versions even a couple of patchlevels earlier are
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	114 highly likely to fail due to syntax changes for some of the
8172ac9d2196 Update some version information for tools based on prodding from Greg Ward. Fred Drake <fdrake@acm.org> parents: 13767 diff changeset	115 pdftex primitives.
6780 9cf8d14f3565 Updated the README to the current status. Added a note about the Guido van Rossum <guido@python.org> parents: 4776 diff changeset	116
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	117 To create PostScript files:
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	118
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	119 - dvips. Most TeX installations include this. If you don't
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	120 have one, check CTAN (<ftp://ctan.tug.org/tex-archive/>).
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	121
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	122 To create info files:
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	123
9870 ee36e1f130cc Update the comments on info files. Fred Drake <fdrake@acm.org> parents: 9764 diff changeset	124 Note that info support is currently being revised using new
ee36e1f130cc Update the comments on info files. Fred Drake <fdrake@acm.org> parents: 9764 diff changeset	125 conversion tools by Michael Ernst <mernst@cs.washington.edu>.
7931 7c7ff1a36521 Added note about current status of info generation. Fred Drake <fdrake@acm.org> parents: 7810 diff changeset	126
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	127 - makeinfo. This is available from any GNU mirror.
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	128
7931 7c7ff1a36521 Added note about current status of info generation. Fred Drake <fdrake@acm.org> parents: 7810 diff changeset	129 - emacs or xemacs. Emacs is available from the same place as
7c7ff1a36521 Added note about current status of info generation. Fred Drake <fdrake@acm.org> parents: 7810 diff changeset	130 makeinfo, and xemacs is available from ftp.xemacs.org.
7c7ff1a36521 Added note about current status of info generation. Fred Drake <fdrake@acm.org> parents: 7810 diff changeset	131
9870 ee36e1f130cc Update the comments on info files. Fred Drake <fdrake@acm.org> parents: 9764 diff changeset	132 - Perl. Find the software at
ee36e1f130cc Update the comments on info files. Fred Drake <fdrake@acm.org> parents: 9764 diff changeset	133 <http://language.perl.com/info/software.html>.
ee36e1f130cc Update the comments on info files. Fred Drake <fdrake@acm.org> parents: 9764 diff changeset	134
15346 563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	135 - HTML::Element. If you don't have this installed, you can get
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	136 this from CPAN. Use the command:
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	137
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	138 perl -e 'use CPAN; CPAN::install("HTML::Element");'
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	139
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	140 You may need to be root to do this.
563dcfec2ae9 Noted that building the info version requires the HTML::Element package, Fred Drake <fdrake@acm.org> parents: 14296 diff changeset	141
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	142 To create HTML files:
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	143
7543 48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	144 - Perl 5.004_04 or newer. Find the software at
48f7ac452d99 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;) Fred Drake <fdrake@acm.org> parents: 7523 diff changeset	145 <http://language.perl.com/info/software.html>.
6780 9cf8d14f3565 Updated the README to the current status. Added a note about the Guido van Rossum <guido@python.org> parents: 4776 diff changeset	146
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	147 - LaTeX2HTML 99.2b8 or newer. Older versions are not
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	148 supported; each version changes enough that supporting
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	149 multiple versions is not likely to work. Many older
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	150 versions don't work with Perl 5.6 as well. This also screws
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	151 up code fragments. ;-( Releases are available at:
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	152 <http://www.latex2html.org/>.
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	153
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	154
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	155 What if Times fonts are not available?
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	156 --------------------------------------
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	157
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	158 As distributed, the LaTeX documents use PostScript Times fonts. This
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	159 is done since they are much better looking and produce smaller
5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	160 PostScript files. If, however, your TeX installation does not support
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	161 them, they may be easily disabled. Edit the file
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	162 texiinputs/manual.cls and comment out the line that starts
10342 8d092a672d09 Lots of small updates. Fred Drake <fdrake@acm.org> parents: 9870 diff changeset	163 "\RequirePackage{times}" by inserting a "%" character at the beginning
8d092a672d09 Lots of small updates. Fred Drake <fdrake@acm.org> parents: 9870 diff changeset	164 of the line. An alternative is to install the right fonts and LaTeX
8d092a672d09 Lots of small updates. Fred Drake <fdrake@acm.org> parents: 9870 diff changeset	165 style file.
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	166
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	167
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	168 What if I want to use A4 paper?
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	169 -------------------------------
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	170
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	171 Instead of building the PostScript by giving the command "make ps",
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	172 give the command "make PAPER=a4 ps"; the output will be produced in
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	173 the paper-a4/ subdirectory. (You can use "make PAPER=a4 pdf" if you'd
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	174 rather have PDF output.)
6780 9cf8d14f3565 Updated the README to the current status. Added a note about the Guido van Rossum <guido@python.org> parents: 4776 diff changeset	175
9cf8d14f3565 Updated the README to the current status. Added a note about the Guido van Rossum <guido@python.org> parents: 4776 diff changeset	176
2583 7914915729e3 adapted to modern times; added section of HTML Guido van Rossum <guido@python.org> parents: 1751 diff changeset	177 Making HTML files
7914915729e3 adapted to modern times; added section of HTML Guido van Rossum <guido@python.org> parents: 1751 diff changeset	178 -----------------
796 136061840624 Made ready for release Guido van Rossum <guido@python.org> parents: 698 diff changeset	179
7523 5e4c2897e625 Overhaul. Fred Drake <fdrake@acm.org> parents: 7127 diff changeset	180 The LaTeX documents can be converted to HTML using Nikos Drakos'
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	181 LaTeX2HTML converter. See the Makefile; after some twiddling, "make"
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	182 should do the trick.
1100 ff1899dcda05 Incorporated Jan-Hein's changes and texinfo conversion. Guido van Rossum <guido@python.org> parents: 804 diff changeset	183
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	184
7761 458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	185 What else is in here?
458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	186 ---------------------
458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	187
458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	188 There is a new LaTeX document class called "howto". This is used for
8945 7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	189 the new series of Python HOWTO documents which is being coordinated by
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	190 Andrew Kuchling <akuchlin@mems-exchange.org>. The file
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	191 templates/howto.tex is a commented example which may be used as a
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	192 template. A Python script to "do the right thing" to format a howto
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	193 document is included as tools/mkhowto. These documents can be
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	194 formatted as HTML, PDF, PostScript, or ASCII files. Use "mkhowto
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	195 --help" for information on using the formatting tool.
8945 7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	196
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	197 For authors of module documentation, there is a file
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	198 templates/module.tex which may be used as a template for a module
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	199 section. This may be used in conjunction with either the howto or
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	200 manual document class. Create the documentation for a new module by
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	201 copying the template to lib<mymodule>.tex and editing according to the
7601a7e9583d Updated to reflect recent changes. Fred Drake <fdrake@acm.org> parents: 8785 diff changeset	202 instructions in the comments.
7761 458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	203
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	204 Documentation on the authoring Python documentation, including
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	205 information about both style and markup, is available in the
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	206 "Documenting Python" manual.
95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	207
7761 458a33abb39c Clarified some comments about the requirements on the TeX installation. Fred Drake <fdrake@acm.org> parents: 7654 diff changeset	208
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	209 Copyright notice
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	210 ================
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	211
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	212 The Python source is copyrighted, but you can freely use and copy it
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	213 as long as you don't change or remove the copyright notice:
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	214
75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	215 ----------------------------------------------------------------------
22062 1087ca519eb9 backport my checkin of Michael W. Hudson <mwh@python.net> parents: 18703 diff changeset	216 Copyright (c) 2000-2002 Python Software Foundation.
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	217 All rights reserved.
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	218
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	219 Copyright (c) 2000 BeOpen.com.
13255 916fb024ce94 Change copyright notice. Guido van Rossum <guido@python.org> parents: 12523 diff changeset	220 All rights reserved.
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	221
16132 8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	222 Copyright (c) 1995-2000 Corporation for National Research Initiatives.
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	223 All rights reserved.
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	224
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	225 Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	226 All rights reserved.
8f6552c7030d A variety of updates of out-of-date information. Fred Drake <fdrake@acm.org> parents: 15346 diff changeset	227
18703 95ea610f3f54 Lots of small updates, some long overdue. Fred Drake <fdrake@acm.org> parents: 16252 diff changeset	228 See the file "texinputs/license.tex" for information on usage and
13255 916fb024ce94 Change copyright notice. Guido van Rossum <guido@python.org> parents: 12523 diff changeset	229 redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7654 75d0048c8643 Add copyright statement. Fred Drake <fdrake@acm.org> parents: 7543 diff changeset	230 ----------------------------------------------------------------------

Mercurial > cpython-lru_cache-weakref

annotate Doc/README @ 25838:8540887bcec6 2.2