| 1 | Python standard documentation -- in LaTeX
|
|---|
| 2 | -----------------------------------------
|
|---|
| 3 |
|
|---|
| 4 | This directory contains the LaTeX sources to the Python documentation
|
|---|
| 5 | and tools required to support the formatting process. The documents
|
|---|
| 6 | now require LaTeX2e; LaTeX 2.09 compatibility has been dropped.
|
|---|
| 7 |
|
|---|
| 8 | If you don't have LaTeX, or if you'd rather not format the
|
|---|
| 9 | documentation yourself, you can ftp a tar file containing HTML, PDF,
|
|---|
| 10 | or PostScript versions of all documents. Additional formats may be
|
|---|
| 11 | available. These should be in the same place where you fetched the
|
|---|
| 12 | main Python distribution (try <http://www.python.org/> or
|
|---|
| 13 | <ftp://ftp.python.org/pub/python/>).
|
|---|
| 14 |
|
|---|
| 15 | The following are the LaTeX source files:
|
|---|
| 16 |
|
|---|
| 17 | api/*.tex Python/C API Reference Manual
|
|---|
| 18 | doc/*.tex Documenting Python
|
|---|
| 19 | ext/*.tex Extending and Embedding the Python Interpreter
|
|---|
| 20 | lib/*.tex Python Library Reference
|
|---|
| 21 | mac/*.tex Macintosh Library Modules
|
|---|
| 22 | ref/*.tex Python Reference Manual
|
|---|
| 23 | tut/*.tex Python Tutorial
|
|---|
| 24 | inst/*.tex Installing Python Modules
|
|---|
| 25 | dist/*.tex Distributing Python Modules
|
|---|
| 26 |
|
|---|
| 27 | Most use the "manual" document class and "python" package, derived from
|
|---|
| 28 | the old "myformat.sty" style file. The Macintosh Library Modules
|
|---|
| 29 | document uses the "howto" document class instead. These contains many
|
|---|
| 30 | macro definitions useful in documenting Python, and set some style
|
|---|
| 31 | parameters.
|
|---|
| 32 |
|
|---|
| 33 | There's a Makefile to call LaTeX and the other utilities in the right
|
|---|
| 34 | order and the right number of times. By default, it will build the
|
|---|
| 35 | HTML version of the documentation, but DVI, PDF, and PostScript can
|
|---|
| 36 | also be made. To view the generated HTML, point your favorite browser
|
|---|
| 37 | at the top-level index (html/index.html) after running "make".
|
|---|
| 38 |
|
|---|
| 39 | The Makefile can also produce DVI files for each document made; to
|
|---|
| 40 | preview them, use xdvi. PostScript is produced by the same Makefile
|
|---|
| 41 | target that produces the DVI files. This uses the dvips tool.
|
|---|
| 42 | Printing depends on local conventions; at our site, we use lpr. For
|
|---|
| 43 | example:
|
|---|
| 44 |
|
|---|
| 45 | make paper-letter/lib.ps # create lib.dvi and lib.ps
|
|---|
| 46 | xdvi paper-letter/lib.dvi # preview lib.dvi
|
|---|
| 47 | lpr paper-letter/lib.ps # print on default printer
|
|---|
| 48 |
|
|---|
| 49 |
|
|---|
| 50 | What if I find a bug?
|
|---|
| 51 | ---------------------
|
|---|
| 52 |
|
|---|
| 53 | First, check that the bug is present in the development version of the
|
|---|
| 54 | documentation at <http://www.python.org/dev/doc/devel/>; we may
|
|---|
| 55 | have already fixed it.
|
|---|
| 56 |
|
|---|
| 57 | If we haven't, tell us about it. We'd like the documentation to be
|
|---|
| 58 | complete and accurate, but have limited time. If you discover any
|
|---|
| 59 | inconsistencies between the documentation and implementation, or just
|
|---|
| 60 | have suggestions as to how to improve the documentation, let is know!
|
|---|
| 61 | Specific bugs and patches should be reported using our bug & patch
|
|---|
| 62 | databases at:
|
|---|
| 63 |
|
|---|
| 64 | http://sourceforge.net/projects/python
|
|---|
| 65 |
|
|---|
| 66 | Other suggestions or questions should be sent to the Python
|
|---|
| 67 | Documentation Team:
|
|---|
| 68 |
|
|---|
| 69 | [email protected]
|
|---|
| 70 |
|
|---|
| 71 | Thanks!
|
|---|
| 72 |
|
|---|
| 73 |
|
|---|
| 74 | What tools do I need?
|
|---|
| 75 | ---------------------
|
|---|
| 76 |
|
|---|
| 77 | You need to install Python; some of the scripts used to produce the
|
|---|
| 78 | documentation are written in Python. You don't need this
|
|---|
| 79 | documentation to install Python; instructions are included in the
|
|---|
| 80 | README file in the Python distribution.
|
|---|
| 81 |
|
|---|
| 82 | The simplest way to get the rest of the tools in the configuration we
|
|---|
| 83 | used is to install the teTeX TeX distribution, versions 0.9 or newer.
|
|---|
| 84 | More information is available on teTeX at <http://www.tug.org/tetex/>.
|
|---|
| 85 | This is a Unix-only TeX distribution at this time. This documentation
|
|---|
| 86 | release was tested with the 1.0.7 release, but there have been no
|
|---|
| 87 | substantial changes since late in the 0.9 series, which we used
|
|---|
| 88 | extensively for previous versions without any difficulty.
|
|---|
| 89 |
|
|---|
| 90 | If you don't want to get teTeX, here is what you'll need:
|
|---|
| 91 |
|
|---|
| 92 | To create DVI, PDF, or PostScript files:
|
|---|
| 93 |
|
|---|
| 94 | - LaTeX2e, 1995/12/01 or newer. Older versions are likely to
|
|---|
| 95 | choke.
|
|---|
| 96 |
|
|---|
| 97 | - makeindex. This is used to produce the indexes for the
|
|---|
| 98 | library reference and Python/C API reference.
|
|---|
| 99 |
|
|---|
| 100 | To create PDF files:
|
|---|
|
|---|
