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

Skip to content

Commit bd40094

Browse files
committed
Updated to reflect recent changes.
1 parent 6fa49e2 commit bd40094

1 file changed

Lines changed: 20 additions & 16 deletions

File tree

Doc/README

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,18 @@ What happened to the Macintosh chapter of the Python Library Reference?
5757
-----------------------------------------------------------------------
5858

5959
The directory mac/ contains the LaTeX sources for the "Macintosh
60-
Library Modules" manual; this is not currently included in the build
61-
system. To build, do the following:
62-
63-
cd Doc/mac
64-
../tools/mkhowto.sh --ps --pdf --html mac
65-
66-
(Any combination of --ps, --pdf, and --html may be used depending on
67-
your needs; the default is --pdf.)
60+
Library Modules" manual; this is built using the standard build
61+
targets, so check the proper output directory for your chosen format
62+
and paper size.
6863

6964

7065
What tools do I need?
7166
---------------------
7267

7368
You need to install Python; some of the scripts used to produce the
74-
documentation are written in Python.
69+
documentation are written in Python. You don't need this
70+
documentation to install Python; instructions are included in the
71+
README file in the Python distribution.
7572

7673
The simplest way to get the rest of the tools in the configuration we
7774
used is to install the teTeX TeX distribution, version 0.4 or 0.9. More
@@ -160,13 +157,20 @@ What else is in here?
160157
---------------------
161158

162159
There is a new LaTeX document class called "howto". This is used for
163-
the new series of Python HOWTO documents which is being coordinated by
164-
Andrew Kuchling <[email protected]>. The file howto.tex is a commented
165-
example which may be used a template. A script to "do the right
166-
thing" to format a howto document is included as tools/mkhowto.sh.
167-
Support for this document class is still new, but is expected to
168-
evolve rapidly. Use "mkhowto.sh --help" for information on using the
169-
formatting tool.
160+
the new series of Python HOWTO documents which is being coordinated by
161+
Andrew Kuchling <[email protected]>. The file templates/howto.tex is a
162+
commented example which may be used a template. A script to "do the
163+
right thing" to format a howto document is included as
164+
tools/mkhowto.sh. Support for this document class is still new, but
165+
is expected to evolve rapidly. Use "mkhowto.sh --help" for
166+
information on using the formatting tool.
167+
168+
For authors of module documentation, there is a file
169+
templates/module.tex which may be used as a template for a module
170+
section. This may be used in conjunction with either the howto or
171+
manual document class. Create the documentation for a new module by
172+
copying the template to lib<mymodule>.tex and editing according to the
173+
instructions in the comments.
170174

171175

172176
Copyright notice

0 commit comments

Comments
 (0)