mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-23 03:05:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15
30277 commits 7 branches 621 tags 3 GiB
Commit graph

86 commits

Author SHA1 Message Date
Fred Drake
c0ed9c4956 clarify where \versionadded and \versionchanged should be placed when 
they are used
 2004-07-13 21:04:26 +00:00
Fred Drake
c7c9a3a958 don't make assumptions about $PATH in Cygwin instructions 2004-05-10 18:39:32 +00:00
Raymond Hettinger
5232f50b19 SF bug: #921927: Fixed a typo/thinko spelling "parameter" as "paramter" 2004-03-25 08:51:36 +00:00
Fred Drake
29f5933fcb add support for \e to the {alltt} environment 2004-02-10 18:30:22 +00:00
Fred Drake
27da291b2c the \file macro is no longer a good example of where \e can't be used 2004-02-09 21:00:29 +00:00
Fred Drake
f0f6d12cd4 add \guilabel macro to mark labels that occur in user interfaces 2004-01-23 08:52:28 +00:00
Fred Drake
4f687b3051 add new reference macro: \seelink 2004-01-08 14:57:27 +00:00
Fred Drake
40b9df2fea add some information about using graphics with the Python document 
classes
 2003-10-11 05:25:24 +00:00
Fred Drake
efb3a161c3 Various minor updates in the description of mkhowto. 2003-10-01 04:15:09 +00:00
Fred Drake
2bc9b2fa2c add commontex/ to the list of directories described here 2003-09-27 07:18:52 +00:00
Fred Drake
9d843087b6 update the documentation contact address 2003-07-30 02:55:28 +00:00
Fred Drake
a66b6c1267 Cygwin instructions: 
- added missing period
- added markup so it's easier to tell which names are special
 2003-07-16 13:50:28 +00:00
Fred Drake
e7f343d0f1 normalize whitespace 2003-07-11 03:36:15 +00:00
Fred Drake
192b95bb6c update the reference to the Apple Publications Style Guide 2003-07-11 03:34:17 +00:00
Neal Norwitz
847207acff SF bug #719367, string exceptions are deprecated 
Remove references to string based exceptions in the doc.
 2003-05-29 02:17:23 +00:00
Martin v. Löwis
36a4d8c20e Remove mentionings of DOS. 2002-10-10 18:24:54 +00:00
Fred Drake
d80032b009 Update some comments about what version of the documentation tools 
code to use.
 2002-09-25 21:41:22 +00:00
Fred Drake
e134158f23 Finish & commit some docs for markup that's been in use for a while. 2002-09-25 18:44:21 +00:00
Barry Warsaw
b8c20a723f More updates describing FutureWarnings. 2002-08-14 16:40:54 +00:00
Greg Ward
8b46c71d5b Typo fix. 2002-06-29 01:23:45 +00:00
Fred Drake
f79f2f94d5 Add additional comments on the use of \deprecated. 2002-05-21 16:27:20 +00:00
Fred Drake
77c18951fb Remove the warning about the Cygwin directions not working -- the latest 
change to Doc/tools/node2label.pl (revision 1.13) makes this work.
 2002-05-02 21:10:48 +00:00
Fred Drake
eb2b8334d5 Added some notes on setting up the documentation tools on Cygwin. 2002-05-01 22:05:30 +00:00
Skip Montanaro
176bda4cde fix duplicate label 
add index turds
 2002-04-19 04:50:44 +00:00
Fred Drake
1251b0eb24 Document the cmemberdesc environment. 2002-04-15 20:10:23 +00:00
Fred Drake
79bf99c505 Document the \csimplemacro macro and the csimplemacrodesc environment. 2002-04-09 20:17:42 +00:00
Fred Drake
e789ea19c1 Extend the list of special characters and magic markup used to produce them 
to include various characters used in code samples, URLs, and other special
contexts.
This closes SF bug #525684.
 2002-03-13 02:48:24 +00:00
Fred Drake
d6bdb075ca Update the list of output formats. 2002-01-17 12:35:20 +00:00
Fred Drake
6ca33771f8 Add a new environment for whole-paragraph (or longer) notes & warnings. 2001-12-14 22:50:06 +00:00
Fred Drake
5ed35fd149 Add a new environment in the Python docs markup: seealso*. This is similar 
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.
 2001-11-30 18:09:54 +00:00
Fred Drake
64a5aaf05c Describe the content given as the parameter to the \note and \warning macros 
in more detail, and use them where appropriate.
 2001-10-20 04:18:14 +00:00
Fred Drake
92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake
203d91a461 Note that the colon following a mail header name should not be included 
when using the \mailheader markup.
Change a couple of inline examples to show the markup rather than the
result.
 2001-09-26 18:43:20 +00:00
Fred Drake
8b3a7b58b9 Move the \mailheader description to the right place. 
Clarify the \mimetype description; it can be used to refer to a part of a
MIME type name, so \mimetype{text} or \mimetype{plain} can be used, not
just \mimetype{text/plain}.
 2001-09-26 17:01:58 +00:00
Fred Drake
f9dc04341d Fix a minor markup typo. 2001-08-29 02:34:10 +00:00
Fred Drake
b5f17f2dc5 Revise comments about TeX & LaTeX for accuracy. 
This closes SF bug #456222.
 2001-08-28 18:09:11 +00:00
Fred Drake
0cac5f697b Added some examples of table markup. 2001-08-14 21:36:19 +00:00
Fred Drake
7eac0cb04c Define the \mailheader macro and document conventions for using it. 2001-08-03 18:36:17 +00:00
Fred Drake
f1b3de8d5c Add labels to all \section and \subsection headings for use in references. 2001-07-24 14:38:34 +00:00
Fred Drake
f269e59232 Define new markup for 5-column tables. 2001-07-17 23:05:57 +00:00
Fred Drake
9120df388c Add a little more information about the usage of some terms where the 
style guide can use a little clarification, and present some minor
specific markup.

Make a few adjustments to conform to the style guide.
 2001-07-14 02:34:12 +00:00
Fred Drake
07178d237a For \kbd, be more prescriptive regarding how keystrokes should be 
written.
 2001-07-12 02:08:29 +00:00
Fred Drake
67f193faab Add a little bit more about the XML migration plan. This still needs a lot 
of work, but mostly it needs time spent doing the work to make the
generated XML useful.
 2001-07-09 16:04:03 +00:00
Fred Drake
432cef0d0b Add new material on some markup that will be checked in shortly. This 
includes some minor new inline markup and markup to generate hyperlinked
grammar productions.

Adopt a "style guide" document -- this beats writing our own and means
we'll have a chance at consistency, without having to make it all up
ourselves.
 2001-07-06 22:34:33 +00:00
Fred Drake
66eed24415 Add some information on the use of \verbatiminput to display sources from 
an external file.
 2001-06-18 14:59:58 +00:00
Fred Drake
9f2376de7a Document the new classdesc* environment, and the previously undocumented 
excclassdesc environment.
 2001-05-11 01:01:12 +00:00
Fred Drake
3151f44d49 Add description of the "explanation" optional parameter added to the 
\versionadded macro.

Note: this should not be merged into the 2.1 maintenance branch.
 2001-04-18 05:19:06 +00:00
Fred Drake
4c6f17a537 Make a number of small clarifications and correct a whole bunch of typos, 
all reported by Bruce Smith.
 2001-04-18 05:12:47 +00:00
Fred Drake
2bbc6974d0 Fix a number of small issues; this closes SF bug #411063. 2001-03-28 16:51:20 +00:00
Fred Drake
b7a52c9de3 Minor typo: \subsubsections --> \subsubsection 2000-11-27 20:10:18 +00:00