Commit Graph

73 Commits

Author SHA1 Message Date
Fred Drake 6356fff2cb give the document indexes 2004-03-23 19:02:38 +00:00
Fred Drake 630e5bd2f7 - use recommended Python style in examples (no spaces around "=" for
keyword args)
- format multi-line calls to distutils.core.setup() consistently, and
  in line with general practice (one keyword arg per line,
  comma/newline after the last
- fix a few typos
2004-03-23 18:54:12 +00:00
Fred Drake 6fca7cc783 merge Anthony Baxter's distutils API reference into the package
author's documentation
2004-03-23 18:43:03 +00:00
Fred Drake 211a2eb784 convert from a howto to a manual 2004-03-22 21:44:43 +00:00
Fred Drake 781380c1f8 - "Mac OS" should always include the space
- comment out documentation for a non-existant feature (--spec-file)
  that the comments indicate isn't clearly needed
- lots of minor markup adjustments to get a more consistent
  presentation
2004-02-19 23:17:46 +00:00
Fred Drake 2a1bc50663 - according to Apple's publication style guide, yes, "Mac people" use
the term Installer (always capitalized, however)
- generalize the text about the term "installer" in a fairly
  reasonable way
2004-02-19 23:03:29 +00:00
Fred Drake a9ee0da8f3 use API documentation style for the descriptions of the additional
functions made available in the post-installation script run by the
Windows installer
2004-02-19 22:28:15 +00:00
Fred Drake c54d9256fb minor markup improvements 2004-02-19 22:16:05 +00:00
Fred Drake 20d4738a95 no reason not to use boilerplate.tex now that it names the PSF 2004-01-23 15:23:49 +00:00
Fred Drake b914ef0a33 list the Python Software Foundation on all the documents 2004-01-02 06:57:50 +00:00
Martin v. Löwis 95cf84a4f3 Patch #821093: Fix various typos. 2003-10-19 07:32:24 +00:00
Thomas Heller 41e2809feb Typo found by Lokasz Pankowski:
dir_created -> directory_created
2003-10-16 19:40:48 +00:00
Thomas Heller 95a97d59c0 Fix a typo, discovered by Joonas Paalasmaa.
Backported to 2.3
2003-10-08 12:01:33 +00:00
Thomas Heller 39cb54b375 Typo: sys.prefex -> sys.prefix
Closes SF# 812152

Baskport candidate for release23-main
2003-09-25 06:26:46 +00:00
Thomas Heller a425dbc7ce Fix a typo found by Eric D. Moyer, closes SF 807813.
Will backport to 2.3.
2003-09-17 17:11:01 +00:00
Fred Drake 2884d6de15 Fix a variety of small markup nits. 2003-07-02 12:27:43 +00:00
Thomas Heller 675580f4fc Document the DISTUTILS_DEBUG variable.
Closes sf #761401.

Backport candidate.
2003-06-30 19:33:29 +00:00
Andrew M. Kuchling e9a54a3eaf [Bug #713722] Delete dangling references to unwritten sections 2003-05-13 15:02:06 +00:00
Fred Drake c440af5495 Updated information on package metadata to reflect recent additions.
This is a modified form of SF patch #718027 (mostly markup changes).
2003-04-25 16:43:28 +00:00
Fred Drake 2a04623ddd - add the "download_url" field to the pre-2.2.3 metadata compatibility note
- fix some markup nits
2003-03-31 16:23:09 +00:00
Andrew M. Kuchling 55fa3bb250 Point e-mail address at the SIG 2003-03-04 19:36:11 +00:00
Andrew M. Kuchling b6b4613ae4 [Bug #693474, reported by Stuart Bishop]
Fix errors in the list of setup() arguments
2003-02-26 18:58:46 +00:00
Raymond Hettinger 3004b090ad SF bug #690377: Dud footnote reference in distutils docs 2003-02-21 02:47:09 +00:00
Andrew M. Kuchling d15f4e3d42 [Patch #658093 ] Documentation support for PEP 301
Add two sections to this manual about package meta-data and about
  registering packages
2003-01-03 15:42:14 +00:00
Thomas Heller 63b4dd33c9 Description of description was really confusing, and added some markup. 2002-12-12 19:35:00 +00:00
Thomas Heller 2c3bfc2a1a Raw documentation for the bdist_wininst postinstallation script.
People are already using it, so these docs are certainly better than
no docs at all. Markup is mostly missing and the layout is probably
ugly, but this can be fixed later.

Question: there are references to MS docs for the CSIDL_... constants
and the IShellLink interface. Are these pointers sufficient, or should
the MS docs reworded and repeated here?
2002-12-12 18:54:19 +00:00
Fred Drake 0e9bfa38b1 Minor markup nits. 2002-11-15 20:34:52 +00:00
Thomas Heller e61f365b0b Document the available command line flags for bdist_wininst, which are
avaliable in the Python 2.2 branch.

I've left out some flags which are more thought for debugging, if
someone needs them, he can always look at the output of --help.

I'm sure Fred will make some adjustments, so I'll only mark this as a
2.2 bugfix candidate.

There are more options available in the current CVS bdist_wininst,
I will document them after this is in.
2002-11-15 20:13:26 +00:00
Thomas Heller 36343f63fe Correct typo: the option is 'formats' not 'format'. 2002-11-15 19:20:56 +00:00
Andrew M. Kuchling d7abe2a0fb Various minor rewrites 2002-05-29 17:33:48 +00:00
Greg Ward 007c04a9d3 [from Oct 2000]
Start fleshing out the "Examples" section.
2002-05-10 14:45:59 +00:00
Greg Ward 954ce8b4a1 [from Oct 2000]
The zipfile module has been in the standard library for some time now.
2002-05-10 14:42:10 +00:00
Greg Ward 58437f20f0 [from Oct 2000]
Clarify explanations of header file search directories.
2002-05-10 14:40:22 +00:00
Andrew M. Kuchling 40df710876 Updates and rewriting 2002-05-08 13:39:03 +00:00
Fred Drake 632bda3aa0 Add more explanation of how data_files is used (esp. where the files end up
in the installation and how that location is determined).
2002-03-08 22:02:06 +00:00
Fred Drake 457c4190f9 Fix typo reported by Joonas Paalasmaa: dada-->data 2001-08-16 21:25:24 +00:00
Fred Drake ab70b38367 Update some incorrect comments about the bdist commands that exist.
Add an entry for the distutils.sysconfig module docs.
2001-08-02 15:13:15 +00:00
Fred Drake 25376c4f8b Documentation for the distutils.sysconfig module. 2001-08-02 15:12:07 +00:00
Fred Drake 17f690f96b Minor changes to match the style guide. 2001-07-14 02:14:42 +00:00
Fred Drake a09262e860 Comment out section titles for sections that have not been written yet;
there is no need to clutter a reader's life with those useless things.

Make the snippets of Python code conform to the standard style.

Suppress the "Contents" page for HTML; it is not needed for small documents
in the online environment since LaTeX2HTML generates lots of tables of links
anyway.

Various markup consistency nits.
2001-03-01 18:35:43 +00:00
Fred Drake f2502adfc1 Fix markup so this document will format. 2001-02-19 19:14:50 +00:00
Thomas Heller 5f52f7230c Checked in with Andrew's blessing, I leave the comments with which
this was posted to distutils-sig in.

Here is what I've hacked together over some spare time
at the weekend. I would appreciate feedback, as I've told
before I'm neither a great author, nor native english speaker,
nor anything else.

Mostly I've completed (and written) docs for bdist_wininst
(where I'm an experert for), also I've started some stuff
for the data_files and scripts option.

Should I continue in this way? Would others like to jump in?
2001-02-19 17:48:03 +00:00
Andrew M. Kuchling da23c4fef9 Fix two typos, and add some omitted \option{} markup 2001-02-17 00:38:48 +00:00
Fred Drake 0ac000cd54 Updates to reflect pending changes to the XML conversion process. 2000-11-22 16:42:37 +00:00
Fred Drake 78489a362e Do not use \verb in the Python documentation -- it makes parsing the LaTeX
sources more difficult and other tools do not always work well with it.
Since we have better markup for this case, just fix it.
2000-11-22 16:06:16 +00:00
Fred Drake 4532dc1bd9 Do not require packages that are not needed. 2000-10-26 21:13:22 +00:00
Fred Drake eff9a87fcc Lots of small markup adjustments for consistency with the rest of the
documentation.
2000-10-26 16:41:03 +00:00
Greg Ward 078fc0816d Typo fix -- it's 'ext_modules', not 'extensions'. 2000-09-12 23:08:53 +00:00
Greg Ward b652897456 Greatly enhanced the section on creating built distributions; in
particular wrote up creating RPMs in detail.
Other scattered improvements.
2000-09-07 02:40:37 +00:00
Greg Ward 54589d4d97 General overhaul of the "Creating a Source Distribution" section --
better explanation of manifest files, in particular.
2000-09-06 01:37:35 +00:00