Commit Graph

566 Commits

Author SHA1 Message Date
Neal Norwitz 25e4461666 Remove references to stdwin which was removed long ago. 2007-05-13 20:54:19 +00:00
Matthias Klose ebde1498e7 - Fix the build of the library reference in info format. 2006-12-09 12:15:27 +00:00
Martin v. Löwis 22f3a6ae1c Add 2.5 libraries. 2006-03-31 16:19:18 +00:00
Fred Drake 7b8cf38927 improve reporting of illegal section nesting (provide location which
caused detection of the error)
2006-03-31 05:30:19 +00:00
Martin v. Löwis 497114e027 Add tool to check documentation against declaration. 2006-03-01 05:18:07 +00:00
Fredrik Lundh ec2f74f4b1 module list utility 2006-01-24 16:16:19 +00:00
Fred Drake aaa28df3ce update to reflect move to Subversion 2006-01-02 07:22:12 +00:00
Fred Drake 5a13e91f72 update URL into the Python wiki
(forward port revision 1.10.4.1)
2005-09-22 19:37:52 +00:00
Fred Drake 346803e060 - fix generated Texinfo markup for \deprecated
- add support for additional markup: \leq, \textbar, \textit
- add a comment about the non-support for the Euro character
(ported from release24-maint branch release 1.10.4.2)
2005-03-10 05:02:18 +00:00
Fred Drake cc933af1ac add missing entries from GNU info conversion table
(ported from release24-maint branch revision 1.10.4.1)
2005-03-10 03:59:35 +00:00
Fred Drake 93f18f6f77 include each row in the package table, even if there are no packages for
that row; the row is commented out in that case
(this makes it easier to modify the table after generation)
2005-01-23 22:14:16 +00:00
Fred Drake 1681b62251 add another way to specify an alternate name for the documentation set,
so that this is harder to forget to do for development of new styles
2004-11-13 17:45:39 +00:00
Fred Drake 5c0ebdcb64 - make the default image type PNG, to match mkhowto
- add a command-line option to control the image type
2004-11-05 04:05:06 +00:00
Fred Drake eac00edd20 fix accidental commit 2004-11-02 19:20:43 +00:00
Fred Drake 303e30ef9f clarify discussion of iteration in the section on the "for" statement
(SF bug #829073)
2004-11-02 19:18:20 +00:00
Tim Peters 3d7d372ce3 Whitespace normalization, via reindent.py. 2004-07-18 06:25:50 +00:00
Andrew M. Kuchling e970d2a310 Add a definition (found in the Debian patches for 2.3.4) 2004-07-17 14:43:32 +00:00
Fred Drake 0751d554c0 generalize a bit; no need to mention my user id directly 2004-07-13 17:08:10 +00:00
Fred Drake 63a0191c8a Deal with macros that have to be replaced with simple text; only a
couple of these are currently found in index data, but these should
all be handled in the same way.

Closes SF bug #952737.
2004-07-08 03:56:12 +00:00
Fred Drake 96b935e643 fix handling when a proper getopt(1) is available; the "--"
end-of-options marker wasn't recognized
2004-06-29 14:39:06 +00:00
Thomas Heller a42bc21ef8 The 'distributing python modules' manual now has an index. 2004-06-18 08:27:36 +00:00
Fred Drake 964c798a94 Use getopt where possible, so this supports option letters that get
jammed together on thos platforms.
2004-06-17 22:04:17 +00:00
Fred Drake 9e1ac2496f - add link to the downloadable package in the generated email
- misc. changes
2004-06-17 18:36:54 +00:00
Fred Drake 0083c920f2 make the tarball available for download instead of throwing it away 2004-06-17 17:19:12 +00:00
Thomas Heller 7d019664d7 Defining Py_GCC_ATTRIBUTE finds even some more undocumented functions. 2004-06-09 18:50:54 +00:00
Thomas Heller 4369b59b6d Public Python functions are nowadays marked PyAPI_FUNC, not DL_IMPORT. 2004-06-09 18:38:20 +00:00
Fred Drake 112f8f4f81 use tools/getversioninfo to extract the version number from the Python
sources
2004-05-11 14:37:55 +00:00
Fred Drake 6d340c3de8 remove assignment to unused variable 2004-05-11 14:25:56 +00:00
Fred Drake 4cc425a0a3 switch to PNG navigation icons by default 2004-04-08 18:51:39 +00:00
Walter Dörwald 70a6b49821 Replace backticks with repr() or "%r"
From SF patch #852334.
2004-02-12 17:35:32 +00:00
Raymond Hettinger 7820554c2c Fix typo 2004-02-08 20:05:40 +00:00
Raymond Hettinger ce9b4714ef SF patch #880552: Fix typo in usage message(prechm.py)
(Contributed by George Yoshida.)

* Also convert tabs to spaces.
2004-02-08 19:24:18 +00:00
Fred Drake 1639f1cef9 fix weird sh-bang line 2003-12-18 05:29:33 +00:00
Fred Drake 2fe79783a7 avoid bash-isms 2003-12-18 05:28:30 +00:00
Fred Drake 3972457de7 make the generated HTML more XHTML friendly 2003-11-25 16:21:00 +00:00
Fred Drake 664a27133c - don't re-write a SourceForge authenticated CVS root into the
anonymous flavor unless the user asks for it on the command line
- decompose SourceForge authenticated CVS roots correctly
2003-10-03 15:21:38 +00:00
Fred Drake 6f75a364e8 normalize whitespace 2003-10-02 16:30:17 +00:00
Fred Drake 4e3a27789a no longer assign into sys; "print chevron" is the way to go 2003-10-01 04:07:44 +00:00
Fred Drake 94b3463f7e We're long past worrying about Python versions older than 1.5.2;
remove old compatibility definition of os.path.abspath().
2003-10-01 04:03:54 +00:00
Fred Drake 1da0bba420 Update to match the version used to build the 2.3.2c1 documentation. 2003-09-29 17:26:08 +00:00
Fred Drake 69db2b967a - change computation of VERSION to use tools/getversioninfo; this is
more reliable than using the $Revision$ expansion
- $RELEASE is no longer needed; we can just use $VERSION now
2003-09-28 22:14:29 +00:00
Fred Drake f7a0d68708 Update the list of directories passed to py2texi.el. The ordering was
wrong, and commontex/ needed to be added.
2003-09-28 03:11:09 +00:00
Fred Drake d4956aac96 Make the "path math" more robust, and support both relative and
absolute paths as input.
2003-09-28 03:10:09 +00:00
Fred Drake c8083cf1cc Load the version information from ../Include/patchlevel.h, so there are
fewer changes to make to version numbers after a release.
2003-09-27 22:07:05 +00:00
Thomas Heller 6122c12031 re.sub expands escape sequences in it's second argument.
Will backport to 2.3 myself.
2003-09-27 19:35:37 +00:00
Fred Drake 2ee37ff191 - use string methods
- make TEXINPUTS work the way it's supposed to in TeX-ish tools
2003-09-27 07:05:12 +00:00
Thomas Heller ccfbfb9ea5 Change the default window size to 1024x768. This shows at least the
whole main page.

Support 2.3 and 2.4 docs in HTMLHelp format.

Already 'backported' to release-23maint.
2003-09-23 20:50:47 +00:00
Fred Drake 9d843087b6 update the documentation contact address 2003-07-30 02:55:28 +00:00
Fred Drake 0bb242b67c Map \envvar to the TeXinfo equivalent, @env. 2003-07-16 03:44:48 +00:00
Fred Drake 850026308b Simple support for the alltt environment. 2003-07-16 03:35:41 +00:00
Fred Drake 7769bb9224 Teach this script about \AA and \aa (the Scandanavian A-ring
characters); \AA is used in whatsnew23.tex.
2003-07-16 03:16:34 +00:00
Fred Drake 6675881aab There's a better way to deal with the "comment" environment; I found
this in SF patch #732174.
2003-07-02 14:44:08 +00:00
Fred Drake 3b09558710 Fill out the set of macros and environments supported somewhat.
Some of this is still pretty iffy.
2003-07-02 14:22:48 +00:00
Fred Drake 0799d0a9e3 Update link to Python book information. 2003-06-20 14:00:49 +00:00
Fred Drake d691c42a38 Include both </tr> tags in the thead, not just the first. 2003-05-29 19:46:29 +00:00
Fred Drake c868d16e11 When an external application we use exits normally, exit with the same
exit code they returned.  All other types of exit from child processes
are normalized to a return code of 1.
Closes SF bug #732143.
2003-05-14 04:16:14 +00:00
Skip Montanaro 15f742dbac first cut at a shell script to view a single section from the library
reference manual
2003-02-13 18:30:08 +00:00
Fred Drake 376f0ef30c Clean up some files that LaTeX2HTML drops in the HTML output directory
sometimes.
2003-01-17 21:25:04 +00:00
Fred Drake 66abcee948 Integrate updates to the GNU info conversion.
This includes SF patch #590352 and additional support for more of the custom
markup.
2002-11-13 19:31:04 +00:00
Fred Drake 4a4734927d More <link> support for generated pages. 2002-10-30 21:32:40 +00:00
Fred Drake b07216b43a Added support for --favicon.
Fix support for the Aesop Meta Type.
2002-10-30 17:05:03 +00:00
Fred Drake 56c8c27b27 Added support for --favicon. 2002-10-30 17:02:21 +00:00
Neal Norwitz d7bc0fec38 Try to fix the broken links caused by multiple \ref on the same line.
SF bug #217195.
Not sure if chomp() is correct, but chop() definitely has problems.
This change seems to have no ill effects.

Backport candidate if Fred agrees.
2002-10-18 02:05:47 +00:00
Fred Drake 2314a0470f Use string methods. Re-organize imports to Python Normal Form. 2002-10-16 16:06:07 +00:00
Fred Drake 27c4e09a62 Only reset _is_empty if needed. 2002-10-16 16:02:08 +00:00
Fred Drake df85f0b09f Modernization: Use string methods, use str instead of
types.StringType, inherit from list instead of
                UserList.
2002-10-16 16:00:42 +00:00
Fred Drake 071972e426 Use string methods. 2002-10-16 15:30:17 +00:00
Fred Drake 06912b7702 Use string methods. Organize the imports in Python Normal Form. 2002-10-16 15:29:07 +00:00
Fred Drake 4fe904d3d6 Use string methods; minor code cleanup. 2002-10-16 14:59:02 +00:00
Fred Drake 816aebdf94 Use the same shade of blue as the site navigation areas. 2002-10-14 15:45:11 +00:00
Fred Drake f834ecbba5 Minor refactoring to avoid code duplication. 2002-10-14 15:04:33 +00:00
Barry Warsaw cfb30e23d1 build(): Use self.builddir, not self.doc when copying the icons, so
they'll end up in the right directory when --dir is used.
2002-10-01 15:38:01 +00:00
Fred Drake c0e066a7b8 When the HTML output dir is specified using --dir=~/foo, the tilde
needs to be expanded by mkhowto, since the shell won't touch it except
at the start of the complete argument.
2002-10-01 15:30:56 +00:00
Fred Drake 73ec98357e Include the --dir argument in the help text. 2002-10-01 15:24:03 +00:00
Fred Drake 15a159c231 Change the default path to icons so that "mkhowto" does the "right thing" by
default when used for 3rd-party docs.  This requires the standard Python docs
to specify a location, but they are a bit of a special case in sharing one set
of icons among several documents.
2002-10-01 15:20:20 +00:00
Fred Drake 246beb2526 Don't use tempfile.mktemp(), since it produces annoying warnings, and
usually isn't what we want anyway.
2002-08-27 16:34:54 +00:00
Fred Drake a132f6c38b Accomodate the packaging changes when we unpack into the dev/doc/ area
on python.org.
2002-08-09 22:56:46 +00:00
Fred Drake 1a0199a74f Lots of changes to the packaging of the documentation, all to keep
directories clean where the packages are unpacked.  Each package now
contains a single directory, Python-Docs-<version>/, which contains the
files for that version of the documentation.

Closes SF feature request #567576.
2002-08-09 20:20:50 +00:00
Fred Drake eab5f8a43d Remove unused variable. 2002-07-09 03:24:32 +00:00
Fred Drake d805fefff4 Added support for some of the more recently defined macros and
environments.
2002-06-27 18:38:06 +00:00
Fred Drake bfc18bdf03 Integrated SF patch #539487 by Matthias Klose:
This patch adds Milan Zamazal's conversion script and
modifies the mkinfo script to build the info doc files
from the LaTeX sources.  Currently, the mac, doc and
inst TeX files are not handled.
Explicitly checks for GNU Emacs 21.
2002-05-03 04:50:51 +00:00
Tim Peters a3b0b298e6 Boost the list of stop words, by merging in the little list Jeremy
just checked into Zope's ZCTextIndex branch.  This reduces the size
of the .chm file by about 100KB.
2002-05-02 21:59:08 +00:00
Fred Drake fe3db7d6f0 Work around limitation of Cygwin Perl: To avoid a permission denial, we need
to do the inplace-edit with a backup file.  A quick test leads me to
believe this is sufficient to allow building the documentation on Cygwin;
a full test is in progress.
2002-05-02 20:42:30 +00:00
Fred Drake 56aa6280f6 list_documented_items(): Basic implementation.
This still does not work well since ctags does not do a good job with the
Python headers, appearantly due to the DL_IMPORT macro.  ;-(
2002-05-01 17:25:04 +00:00
Skip Montanaro d268183044 moved from Tools/scripts (was only at rev 1.1 - no changes yet - so I simply
removed it from there and added it here)
2002-04-30 16:25:37 +00:00
Tim Peters 4a0db06edf Hack around the "2.1.6 Blank lines" bug in a way that the TOC still
displays a recognizable section title (there are extra blanks at the
end of it now, due to the nested anchor, but that's fine).
2002-04-21 04:44:11 +00:00
Tim Peters dc374e034a Give the Help viewer a font-size button. This isn't documented by MS,
but is documented by others on the web, and the defn of the magic flag
needed appears in MS's htmlhelp.h header file.
2002-04-21 02:01:01 +00:00
Tim Peters c8490c70cd Move "everything left one": the TOC now shows each doc directory as a
distinct top-level node.  Before they were all nested under an artificial
top-level node, uselessly chewing up horizontal space, and ensuring that
the only thing the user saw in the TOC upon opening the file was a single
collapsed top-level folder.
2002-04-20 21:34:34 +00:00
Tim Peters 4545407746 Stopped all warnings from the HTML Help Compiler, by generating proper
HTML (or, at least, proper in its view).  The TOC file is now identical
to what the HTML compiler itself generates, except for whitespace and
a glitch identified below.  The pretty-printing done by prechm.py is
pretty much destroyed for now; if you need it pretty-printed, just make
the Help Compiler save the files (it's got its own idea of pretty-
printing anyway).

Glitch:  The title of Ref Man "2.1.6 Blank lines" shows up as a blank
for now.  This is because the relevant entry in ref/index.html contains
nested anchors, and pychm really has no idea what to do with that.  I
hacked it for now to avoid any error messages or worse insanity, and
filed a bug report against the docs.
2002-04-20 20:26:26 +00:00
Tim Peters e21095e3c5 Widespread: Used classes in a more natural way. Added convenience
methods to squash code duplication.  Simplified several overly complex
chunks of logic.  Built output strings more with string interpolation
instead of infix '+'.  Added comments.  Exploited recent Python features
(chiefly bool and augmented assignment).
2002-04-20 08:36:42 +00:00
Tim Peters d9a10509ac Replaced the fiddly 5-tuples with a new Book convenience class, allowing
to reference fields via names instead of meaningless little integers.
This turned up one case where the wrong little integer was being used,
in informative progress output.  Fixed that too.
2002-04-20 03:25:02 +00:00
Tim Peters 8d62ad7ffd Fixed a comment. 2002-04-20 02:56:20 +00:00
Tim Peters 661e49231a All over: get rid of blanks before colons that open code blocks. 2002-04-20 02:39:44 +00:00
Tim Peters 460643b8c5 do_project(): Modernized the code. 2002-04-20 02:37:07 +00:00
Tim Peters 5d5e1930dd Added "What's New" to the 2.2 doc set. 2002-04-20 02:07:58 +00:00
Tim Peters 4f109c1cf9 Added a stop-list to reduce the size of the full text search index. Fred,
populate the "stop_list" triple-quoted string with your favorite handful
of stop words.
2002-04-19 18:41:46 +00:00
Tim Peters e6b63e685b project_template: use dict interpolation instead of giant tuples. 2002-04-19 18:07:52 +00:00
Tim Peters a905363ce5 + Changed TOC to folder-tree style.
+ Increased size of the window the user sees the first time.
+ Arranged for the display to remember its last size and position.
+ Added a Favorites (bookmarks) tab.
+ Added the "Advanced Search" decorations.
2002-04-19 16:46:43 +00:00
Tim Peters 52cfa33e6e Generates inputs to the Microsoft Help Compiler, which creates compiled
HTML help files (.chm).  Obtained from Robin Dunn's packaging of the
2.2 docs at <http://alldunn.com/python/>, obtained in turn from
Hernán Martínez Foffani's original work at
<http://www.orgmf.com.ar/condor/pytstuff.html>.
2002-04-19 16:09:26 +00:00
Fred Drake bab5aa0039 Remove Emacs turd; not needed with modern Emacs versions.
Add a -r option; if given with a release number, the "What's New" document
is included with the relevant version number.

Update the text of the README distributed with the PostScript files to
reflect the changes in the user organizations in the Python community.
2002-04-17 03:29:40 +00:00