Commit Graph

524 Commits

Author SHA1 Message Date
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
Fred Drake 34a05f7a1f Start of script to locate C symbols and segregate them into lists of
the documented and undocumented symbols.
2002-04-16 21:27:17 +00:00
Thomas Heller 0e661dcdbf Replace the simpleminded string.find with a re.search looking only for
full words. Before that, something like 'PyObject_Call' was missed
because 'PyObject_CallFunction' was found.

Passes PyChecker now.
2002-04-16 15:04:56 +00:00
Fred Drake 3c1ff5c766 When adding a name to the table of macros and environments, make sure it
is not already present.  If it is, raise an exception, since that should not
happen in a well-defined conversion.
2002-04-10 04:20:33 +00:00
Fred Drake 0047e16d1b Added support for \csimplemacro and csimplemacrodesc. 2002-04-10 04:19:12 +00:00
Fred Drake d15a0a05d3 Fix bug in command line handling, noted by Fredrik Lundh. 2002-04-05 18:09:22 +00:00
Fred Drake e03e1fe5cc Add support for the "Aesop Meta Tag". Not widely used, but not a bad idea,
either.
2002-04-05 17:34:50 +00:00
Fred Drake 9b3e2ca74d Add support for \textgreater, \textless.
Updated productionlist environment.
2002-04-04 21:39:42 +00:00
Fred Drake e13602ee49 Mark the notice about the new development version of the docs as not needing
to be archived.  Most of these are pretty bland.  ;-)
2002-04-04 18:06:06 +00:00
Fred Drake f54519d9e4 Update to push the docs to python.org instead of python.sf.net. 2002-04-01 20:15:05 +00:00
Fred Drake baf43c5036 When linking to an index page, explicitly name index.html instead of
using "./".  The later does not work nicely when browsing docs on a local
disk (as in the installed docs on Windows).
2002-02-04 21:15:42 +00:00
Fred Drake 3d422662ad Make this do the right thing with entries which start with the percent sign,
in response to Skip's comments in SF bug #487165.

Make use of string methods instead of string module functions in most places.
Add (and make the default) a way to collapse symbol entries into a single
"Symbols" section in the generated index.  This is similar to what makeindex
does, but does not include entries beginning with an underscore.
2001-12-26 19:55:14 +00:00
Fred Drake b9c0ef5db7 Update to reflect recently added markup. 2001-12-15 22:24:06 +00:00
Fred Drake 73f0a4ecd7 Script to generate the table of distribution packages, plugging in the size
information automatically.
2001-12-08 00:26:07 +00:00
Fred Drake b48b6d0737 Remove meaningless comment. 2001-12-04 16:32:04 +00:00
Fred Drake 381832ead5 Drop xmllib in favor of SAX. 2001-11-30 19:30:03 +00:00
Fred Drake 1e53fa7907 Add a couple of entries to the whitespace-cleanups table. 2001-11-30 19:25:39 +00:00
Fred Drake 95e33f03ba Added two new conversion specifications. 2001-11-30 19:06:18 +00:00
Fred Drake ea4d2c0241 A few small changes:
- Change PREFIX to PREFIXES, which contains a sequence of prefix strings.
  This is useful since we want to look for both Py and PY.
- Wrap a long line.
- Collect struct tags as well as typedef names.  Since we generally only
  use one of the other, that improves coverage.
- Make the script executable on Unix.

This could use a better approach to determine if a symbol is documented,
and could easily avoid keeping the massive string in memory.  That would
take time to actually write more code, though, so we'll bail on that
for now.
2001-11-29 04:30:46 +00:00
Fred Drake 27ae311864 Avoid trailing blank lines in the output. 2001-11-19 05:28:29 +00:00
Fred Drake 00c96aeba6 Adjust input pre-processing so that a comment on the last line does not
break the processor; this will do the right thing.
2001-11-19 05:27:40 +00:00
Thomas Heller 64cdb48c80 No need to preprocess the header files - use ctags -I flag instead to
remove DL_IMPORT.
2001-11-12 12:52:01 +00:00
Thomas Heller 3988574075 Remove my name, probably bad style. 2001-11-09 17:04:43 +00:00
Thomas Heller 3e77423a64 Script to print undocumented symbols found in Python header files. 2001-11-09 16:50:35 +00:00
Fred Drake 3ce28e4bd0 Add a new option, --dvips-safe, which sets the $DVIPS_SAFE option in
LaTeX2HTML.  This is not safe to do in general (for the reasons LaTeX2HTML
protects against dvips to begin with), but is safe if we do not actually
need to run dvips.  Note that we also assume it is safe if the user
specifically requests PostScript generation.  See the comments for further
explanation.
2001-10-30 16:09:51 +00:00
Fred Drake af876d77e0 One more LaTeX-ism that we'd rather ignore. 2001-10-25 15:14:57 +00:00
Fred Drake a281665972 No need to run make twice here. 2001-10-25 15:13:30 +00:00
Fred Drake f10584cb11 Do a little bit more to try and add <link> elements to the header, not that
Mozilla 0.9.5 can make intelligent use of them.  Specifically, this causes
the "Acknowledgements" and "Global Module Index" pages to acquire "up"
links in the Mozilla "Site Navigation Bar".
This partially responds to SF bug #469772.
2001-10-22 15:07:16 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake ac1af8093e Handle PEP references the same way RFC references. 2001-09-29 19:07:22 +00:00
Fred Drake 583061a10f Fix up whitespace in <args> elements; reduce sequences of consecutive
whitespace characters to a single space.
Small changes elsewhere, mostly to clean up the code a little.
2001-09-29 05:05:25 +00:00
Fred Drake 3c171d1b9f Convert to string methods.
For the real document element, make sure the prolog is migrated into
the document element so it isn't left stranded.

Make fixup_trailing_whitespace() whitespace do what was really intended.

Add the *desc environments used in the C API manual to the list of
things that can exist at the paragraph level so they don't get wrapped
in <para>...</para>.
2001-09-28 17:14:35 +00:00
Fred Drake 0f9bfd3dda Convert most uses of the string module to string methods.
(string.join() lives!)
2001-09-28 16:26:13 +00:00
Fred Drake 876389e5d8 Do not distinguish \refmodule from \module in the generated output;
whether or not a link will be generated will depend on the link database.
Add a couple of explanatory comments for one of the stranger constructs
(giving input an empty name).
2001-09-27 17:01:59 +00:00
Fred Drake 9213b7a961 Re-write <ulink> elements as described in the conversion spec. 2001-09-27 16:52:22 +00:00
Fred Drake baacc08ead Turn \input, \include, and \verbatiminput into XInclude elements instead
of something ad-hoc.
2001-09-27 15:49:23 +00:00
Fred Drake b6fa78930e Add support for some more markup that had slipped in.
Fixed a typo in a comment.
2001-09-27 04:18:39 +00:00
Fred Drake 29a67ced72 Update to support \mailheader and 5-column tables. 2001-09-25 20:58:13 +00:00
Fred Drake 9eda3aebb8 Simplify a helper by returning fewer values. 2001-09-25 20:57:36 +00:00
Fred Drake 1cb560a653 Do more to be compatible with Windows/CygWin. Make error messages more
informative when a child process dies with an error.

This is a variation of parts of SF patch #429611.
2001-08-10 20:17:09 +00:00
Fred Drake e54acfd8b2 Add option to push the development docs to SF without announcing, for
when the changes are just too small.
2001-08-08 05:41:01 +00:00
Fred Drake 1ca78b6b70 Change the command lines to use a similar "phrasing" to that used in the
other documentation makefiles.  This is probably not sufficient to run
the conversion on Windows, but goes at least part way.
2001-07-18 18:32:38 +00:00
Fred Drake 3cae66bdbc Script to re-write @FOO@-style marks with values, initializing the
replacement for @DATE@ from a TeX file containing a \date{...} mark
(such as texinputs/boilerplate.tex).

This will be used to re-write the html/index.html.in file instead of
a combination of grep, date, and sed -- this is more portable to non-Unix
platforms.

This solves part of the problem reported in SF patch #429611, but does
not use the suggested patch.
2001-07-17 16:46:14 +00:00