[Python-checkins] CVS: python/dist/src/Doc README,1.44,1.45
Fred L. Drake
fdrake@users.sourceforge.net
Wed, 18 Jul 2001 13:01:17 -0700
Update of /cvsroot/python/python/dist/src/Doc
In directory usw-pr-cvs1:/tmp/cvs-serv28340
Modified Files:
README
Log Message:
Lots of small updates, some long overdue.
Index: README
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/README,v
retrieving revision 1.44
retrieving revision 1.45
diff -C2 -r1.44 -r1.45
*** README 2001/01/25 17:25:28 1.44
--- README 2001/07/18 20:01:15 1.45
***************
*** 1,4 ****
! Python main documentation -- in LaTeX
! -------------------------------------
This directory contains the LaTeX sources to the Python documentation
--- 1,4 ----
! Python standard documentation -- in LaTeX
! -----------------------------------------
This directory contains the LaTeX sources to the Python documentation
***************
*** 10,19 ****
or PostScript versions of all documents. Additional formats may be
available. These should be in the same place where you fetched the
! main Python distribution (try <http://www.python.org> or
! <ftp://ftp.python.org>).
The following are the LaTeX source files:
api/*.tex Python/C API Reference Manual
ext/*.tex Extending and Embedding the Python Interpreter
lib/*.tex Python Library Reference
--- 10,20 ----
or PostScript versions of all documents. Additional formats may be
available. These should be in the same place where you fetched the
! main Python distribution (try <http://www.python.org/> or
! <ftp://ftp.python.org/pub/python/>).
The following are the LaTeX source files:
api/*.tex Python/C API Reference Manual
+ doc/*.tex Documenting Python
ext/*.tex Extending and Embedding the Python Interpreter
lib/*.tex Python Library Reference
***************
*** 31,43 ****
There's a Makefile to call LaTeX and the other utilities in the right
! order and the right number of times. This will produce DVI files for
! each document made; to preview them, use xdvi. PostScript is produced
! by the same Makefile target that produces the DVI files. This uses
! the dvips tool. Printing depends on local conventions; at our site,
! we use lpr. For example:
!
! make lib # create lib.dvi and lib.ps
! xdvi lib # preview lib.dvi
! lpr lib.ps # print on default printer
--- 32,49 ----
There's a Makefile to call LaTeX and the other utilities in the right
! order and the right number of times. By default, it will build the
! HTML version of the documnetation, but DVI, PDF, and PostScript can
! also be made. To view the generated HTML, point your favorite browser
! at the top-level index (html/index.html) after running "make".
!
! The Makefile can also produce DVI files for each document made; to
! preview them, use xdvi. PostScript is produced by the same Makefile
! target that produces the DVI files. This uses the dvips tool.
! Printing depends on local conventions; at our site, we use lpr. For
! example:
!
! make paper-letter/lib.ps # create lib.dvi and lib.ps
! xdvi paper-letter/lib.dvi # preview lib.dvi
! lpr paper-letter/lib.ps # print on default printer
***************
*** 139,147 ****
<http://language.perl.com/info/software.html>.
! - LaTeX2HTML 99.2b8. Older versions are not supported; each
! version changes enough that supporting multiple versions is not
! likely to work. Many older versions don't work with Perl
! 5.6 as well. This also screws up code fragments. ;-(
! Releases are available at: <http://www.latex2html.org/>.
--- 145,154 ----
<http://language.perl.com/info/software.html>.
! - LaTeX2HTML 99.2b8 or newer. Older versions are not
! supported; each version changes enough that supporting
! multiple versions is not likely to work. Many older
! versions don't work with Perl 5.6 as well. This also screws
! up code fragments. ;-( Releases are available at:
! <http://www.latex2html.org/>.
***************
*** 162,168 ****
-------------------------------
! Instead of building the PostScript by giving the command "make", give
! the command "make PAPER=a4 ps"; the output will be produced in the
! paper-a4/ subdirectory. (You can use "make PAPER=a4 pdf" if you'd
rather have PDF output.)
--- 169,175 ----
-------------------------------
! Instead of building the PostScript by giving the command "make ps",
! give the command "make PAPER=a4 ps"; the output will be produced in
! the paper-a4/ subdirectory. (You can use "make PAPER=a4 pdf" if you'd
rather have PDF output.)
***************
*** 172,177 ****
The LaTeX documents can be converted to HTML using Nikos Drakos'
! LaTeX2HTML converter. See the Makefile; after some twiddling, "make
! html" should do the trick.
--- 179,184 ----
The LaTeX documents can be converted to HTML using Nikos Drakos'
! LaTeX2HTML converter. See the Makefile; after some twiddling, "make"
! should do the trick.
***************
*** 195,199 ****
--- 202,210 ----
instructions in the comments.
+ Documentation on the authoring Python documentation, including
+ information about both style and markup, is available in the
+ "Documenting Python" manual.
+
Copyright notice
================
***************
*** 203,207 ****
----------------------------------------------------------------------
! Copyright (c) 2000, 2001 Guido van Rossum.
All rights reserved.
--- 214,218 ----
----------------------------------------------------------------------
! Copyright (c) 2000, 2001 Python Software Foundation.
All rights reserved.
***************
*** 215,219 ****
All rights reserved.
! See the file "LICENSE" for information on usage and
redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
----------------------------------------------------------------------
--- 226,230 ----
All rights reserved.
! See the file "texinputs/license.tex" for information on usage and
redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
----------------------------------------------------------------------