summaryrefslogtreecommitdiffstats
path: root/Doc/perl/python.perl
Commit message (Collapse)AuthorAgeFilesLines
* Squash an enormous number of warnings reported when adding "useFred Drake2002-11-151-128/+138
| | | | | | | | | | warnings;" to this, and keep the "use" statement this time. Fix an obscure bug that caused weird index entries to be generated in a few cases, and a minor problem with horizontal alignmetn of the last column of 5-column tables. [I'd report a SF bug #, but I can't get to that right now.]
* - Committing the modified signature lines I've been using for a longFred Drake2002-11-131-3/+7
| | | | | | time in http://www.python.org/dev/doc/. There have been no bug reports on these for a long time now. - Remove local "use" statement that duplicates a top-level "use".
* Add \funcline, \funclineni, and \methodlineni to the list of functionsFred Drake2002-11-131-0/+3
| | | | | that are processed before their arguments. Closes SF bug #637807.
* Hackish way to generate an up-<link> for the title page if we haveFred Drake2002-10-301-4/+16
| | | | | | one. Added misc. comments.
* \productioncont: Replace leading spaces with &nbsp; so that it'sFred Drake2002-06-181-0/+3
| | | | | | | | | possible to control the indentation of continuation lines. cfuncline_helper(): Only mark the argument names are <var>, not the whole argument list. This leaves the argument types in the same font as the return type. Based on a casual suggestion from Guido.
* Refactor the generation of signature lines for funcdesc, methoddesc,Fred Drake2002-06-181-27/+22
| | | | | | and friends. This was part of the changes to the presentation of signature lines, but does not include any of the aspects that people questioned.
* Ensure \verbatiminput always uses a unique filename for each input file inFred Drake2002-06-171-8/+66
| | | | | | the "Download as text" link. Previously, it could map multiple source files to a single name since all files end up with the same extension. This closes SF bug #558279.
* Use Perl function prototypes to help avoid definition/usage mismatchesFred Drake2002-05-231-82/+86
| | | | | while modifying these files. Minor style changes to make the use of "my" with arrays more consistent.
* Separate out a \cfuncline macro from the cfuncdesc environment.Fred Drake2002-04-151-8/+21
| | | | | This matches many other of the *desc environments, and is useful when multiple functions share a description.
* Generate the right annotations in the index entries.Fred Drake2002-04-151-2/+2
| | | | Thanks to Thomas Heller for the sharp eye.
* Clean up the application of style to verbatim text.Fred Drake2002-04-151-5/+5
| | | | | | | This moves styling to the stylesheet; the use of <dl> structures to control style sometimes produced improper indentation of subsequent text in many browsers when the text was already part of the <dl> structure (as in a function or class description).
* Add support for \cmemberline and the cmemberdesc environment.Fred Drake2002-04-151-0/+24
|
* Update the PEP URL format to point to python.org.Fred Drake2002-04-031-1/+1
|
* Revise the markup related to the grammar productions to increase theFred Drake2002-03-151-0/+13
| | | | | | level of predictability. This is not really "good" markup, but is arguably better than we had before. This closes SF bug #523117.
* Change the way \textasciitilde is implemented so it works more consistentlyFred Drake2002-03-131-1/+1
| | | | | (dropping tildes into data that still goes through LaTeX-like processing is a bad idea).
* Add implementations for \textgreater and \textless, defined in (relatively)Fred Drake2002-03-051-0/+2
| | | | recent versions of LaTeX2e but not support in LaTeX2HTML.
* Add a new environment for whole-paragraph (or longer) notes & warnings.Fred Drake2001-12-141-2/+21
|
* The valign attribute to control the vertical alignment of a table cell shouldFred Drake2001-12-141-3/+3
| | | | | be on the <tr> element, not the <table> element. Partially fixes SF bug #493243.
* Remove crufty whitespace in a block of index entries.Fred Drake2001-12-111-0/+1
| | | | | Minor, but generates slightly smaller HTML & makes it easier to see what's happening when debugging the HTML.
* Add a new environment in the Python docs markup: seealso*. This is similarFred Drake2001-11-301-0/+6
| | | | | | | | to seealso, but does not add the "See also:" header or put the content in a box in the HTML version. Updated the description of \seeurl to better indicate when it should be used; the old description was written before we had \seetitle.
* Add yet more markup that let's a stylesheet pick out a small bit of theFred Drake2001-10-261-3/+11
| | | | | presentation. This is acceptable since it only occurs in the formatted output and does not affect the document markup.
* New markup: \note{...} and \warning{...}Fred Drake2001-10-091-0/+10
|
* Move the styling for the HTML version of \mailheader into the CSS file.Fred Drake2001-09-261-1/+1
| | | | | | In both the HTML and typeset versions of the documentation, add a colon after the name of a mail header so that it is more easily distinguished from other text.
* New \grammartoken markup, similar to \token but allowed everywhere.Fred Drake2001-08-201-0/+4
|
* fix_font(): Instead of using a long if/elsif cluster, use a bloodyFred Drake2001-08-161-23/+16
| | | | | dictionary. Added some entries to the dictionary to fix part of SF bug #451556.
* Define the \mailheader macro and document conventions for using it.Fred Drake2001-08-031-0/+2
|
* Define new markup for 5-column tables.Fred Drake2001-07-171-7/+72
|
* Add support for \ulink and hyperlink grammars.Fred Drake2001-07-061-2/+151
| | | | | | | do_cmd_verbatiminput(): Write out a text file containing the content of the input file with a .txt extension, and add a link to it at the bottom of the presentation. This easier retrieval of example source code for copy & paste use.
* Added support for our new \infinity and \plusminus macros, and theFred Drake2001-06-231-1/+4
| | | | | | standard \textbar macro (not supported in many versions of LaTeX2HTML). Added newline to error message.
* Added support for new \setreleaseinfo macro.Fred Drake2001-06-201-65/+76
| | | | | | | Normalize all generated HTML so that attribute names come out as name="value" instead of name='value'. Changed the target of RFC links to point to the hypertext RFCs at www.faqs.org instead of the plain text RFCs at www.ietf.org.
* Implement the \verbatiminput LaTeX macro; this contains more magic thanFred Drake2001-06-151-0/+46
| | | | it should, but only enough that LaTeX2HTML doesn't bite us.
* Define a new environment, classdesc*, which can be used to document aFred Drake2001-05-111-0/+11
| | | | | | class without providing any information about the constructor. This should be used for classes which only exist to act as containers rather than as factories for instances.
* The (fairly recent) \textasciicircum is not supported by LaTeX2HTML; addFred Drake2001-04-211-0/+1
| | | | support for it here.
* Added support for optional explanation parameter to the \versionaddedFred Drake2001-04-181-13/+14
| | | | | | | | macro. Refactored do_cmd_versionadded() and do_cmd_versionchanged() to do most of the work in a helper function, with the do_cmd_*() wrappers just supplying a portion of the replacement text.
* When forming the <A> tag for a \seepep or \seerfc, make sure we stripFred Drake2001-04-121-1/+10
| | | | | | HTML markup from the string used as the title in the TITLE attribute. This fixes formatting in the "What's New in Python 2.1" document.
* Add corresponding support for the alltt environment to the HTML generator.Fred Drake2001-04-101-0/+46
|
* Remove the spurious space of uncertain origin from the output for function,Fred Drake2001-03-291-10/+10
| | | | | method and constructor signatures. Suggested by Peter Funk on the Doc-SIG mailing list.
* Label classes and exceptions explicitly in the documentation (for theirFred Drake2001-03-021-2/+4
| | | | *desc environments).
* Fix \seepep handling -- correct URL to the online PEP repository on SF isFred Drake2001-01-221-27/+39
| | | | | | | | | | | | now generated. (SF bug #129692.) Patch from Anthon van der Neut <anthon@mnt.org>: Work around the removal of content-less paired tags used for name anchors in some places. (SF bug #116008.) Move some class attributes from an artificial SPAN element to otherwise "useful" elements that are being generated anyway. Added the class "versionnote", used for \deprecated, \versionadded, \versionchanged.
* For the title page, insert the package version number before the date.Fred Drake2000-12-141-3/+3
| | | | | This makes the title area more like the title are of the top-level index, and puts the information more people are interested in first.
* A few small refinements to the table building code.Fred Drake2000-11-301-7/+10
|
* define_module(): Change the "index sub-item" for definitions at moduleFred Drake2000-10-301-1/+1
| | | | | | | scope to be " (in module <name>)" instead of " (in <name>)" to be consistent with \withsubitem usage throughout the documentation. This achieves consistency in indexing throughout the documentation.
* Normalize the HTML generated for table headers.Fred Drake2000-10-261-7/+10
|
* Rename $PYTHON_VERSION to $PACKAGE_VERSION; this is the version number forFred Drake2000-10-251-5/+8
| | | | | whatever is being documented, not necessarily Python. (These tools are also used for the How-To documents, etc.)
* $OFF_SITE_LINK_ICON: Don't define here; simply defining it overrides aFred Drake2000-10-031-7/+11
| | | | | | | | | | | | | | | | | | | definition provided by previously loaded configuration code, and testing whether it's defined isn't needed since the default was false anyway. get_link_icon(): Add support for $OFF_SITE_LINK_ICON_HEIGHT and $OFF_SITE_LINK_ICON_WIDTH, giving the dimensions of the icon being used. This can make for faster page display. Both are optional. make_my_titlegraphic(): Fix insertion of the off-site icon link. do_env_funcdesc(): Remove debugging print. handle_rfclike_reference(): Remove trailing colon from first line; it doesn't really make sense and looks bad if we add an icon to mark off-site links.
* make_icon_filename(): Convenience function to turn a partial filenameFred Drake2000-10-021-20/+45
| | | | | | | | | | | into a usable filename using $ICONSERVER and $IMAGE_TYPE as needed. get_link_icon(): Function to examine a URL and return the string to use to insert an icon if the link points off-site, if needed and $OFF_SITE_LINK_ICON is set. Adjusted appropriate places to use these new functions.
* use_sans_serif(),Fred Drake2000-09-221-10/+7
| | | | | | | | | | | | use_italics(): Remove both functions, inlining use_italics() at its only call site. init_myformat(): Uncomment line so that some internal markup does not get generated, since it is not properly removed later. (Fix on aspect of SourceForge bug #114749.) Modified call to process_commands_wrap_deferred(), removing \code from the list since it had a bad interaction with other changes in some contexts.
* Add new environments: longtableii, longtableiii, and longtableiv, toFred Drake2000-09-211-0/+12
| | | | | support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
* do_cmd_shortversion(),Fred Drake2000-09-141-11/+32
| | | | | | | | | | | | | | | | | | | | | | | do_cmd_setshortversion(): Implementation for new markup. convert_args(): New helper function. do_cmd_optional(): Modified to understand when it is called from within a convert_args() invocation. do_env_funcdesc(), do_env_funcdescni(), do_cmd_funcline(), do_cmd_funclineni(), handle_classlike_descriptor(), do_env_methoddesc(), do_end_methoddescni(), do_cmd_methodline(), do_cmd_methodlineni(): Modified to use helper convert_args(). The convert_args() helper and related changes fix the generation of HTML for the \optional markup, so that bogus </var>...<var> is not generated. This closes SourceForge bug #113800.
* \seetitle: New macro for building reference list content.Fred Drake2000-09-121-0/+19
|