Commit Graph

51 Commits

Author SHA1 Message Date
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
Greg Ward 47f99a6174 Fleshed out the section on the setup config file, setup.cfg.
Added a few clarifying footnotes and cross-references.
Various minor tweaks.
2000-09-04 20:07:15 +00:00
Greg Ward e3cca26627 Added abstract. 2000-08-31 16:36:31 +00:00
Greg Ward 1365a300a1 Get rid of "sec:" prefix that slipped into a couple of \label's. 2000-08-31 14:47:05 +00:00
Greg Ward 2afffd42fa Wrote the "Describing extension modules" section. 2000-08-06 20:37:24 +00:00
Greg Ward 1d8f57a5a4 A bundle of wording improvements, corrections, clarifications, updates,
and so forth.
2000-08-05 00:43:11 +00:00
Fred Drake 01df453f16 Update Python version numbers from 1.6 to 2.0 where appropriate.
Make some references between the distutils documents hyperlinks using
the \citetitle markup.
2000-06-30 03:36:41 +00:00
Greg Ward 1bbe32982d Minor wording tweaks.
Kludged the extra-wide table that summarizes the manifest template language
  (works with LaTeX, but is an *evil* kludge and could well break LaTeX2HTML
  or similar...).
2000-06-25 03:14:13 +00:00
Greg Ward 370248d705 Some clarifications to the 'A simple example' section. 2000-06-24 01:45:47 +00:00
Greg Ward 19c67f83ad Fixed a grab-bag of typos spotted by Detlef Lannert. 2000-06-24 01:33:16 +00:00
Greg Ward 6153fa19ce Guido's rewording of my definition of "root package", with an addition by me. 2000-05-26 02:24:28 +00:00
Greg Ward 59d382e482 A grab-bag of wording tweakage. 2000-05-26 01:04:47 +00:00
Gregory P. Smith 147e5f3c65 Doc patch from Bastein Kleineidam: start to describe the 'install' command
family, including the new 'install_scripts' and 'install_data' commands.
2000-05-12 00:58:18 +00:00
Greg Ward e78298a6bd Stripped leading 'sec:' from all section labels -- generates bad filenames,
bad link URLs in HTML, etc.
2000-04-28 17:12:24 +00:00
Greg Ward 4a9e72266d Added section headers for "Extending the Distutils" section (just
a reminder to myself).
2000-04-25 02:57:36 +00:00
Greg Ward 87da1ea127 Patch from Andrew Kuchling: document the new multiple pattern feature in the
manifest template.
2000-04-21 04:35:25 +00:00
Greg Ward d5767a5e43 Reformatted wide paragraphs. 2000-04-19 22:48:09 +00:00
Greg Ward 1ecc251538 Changed '\package' to \module'. 2000-04-19 22:36:24 +00:00
Greg Ward a021acacfb Changed '\option' to '\longprogramopt' wherever it referred to a command-line
option.
2000-04-19 22:34:11 +00:00
Greg Ward 46b98e35fd Various wording/formattin tweaks.
Started spewing "Creating Built Distributions" section.
2000-04-14 01:53:36 +00:00
Greg Ward c248baecb3 Moved definition of \XXX command out to distutils.sty. 2000-04-09 20:55:35 +00:00
Greg Ward facb8dbaeb Fixed so LaTeX can actually process it, and so it looks like the other
Distutils manual.
2000-04-09 04:32:40 +00:00
Greg Ward 16aafcd85b Got started for real on this manual. Completely untested and unread -- just
checking it in so I can move things around in the CVS repository.
2000-04-09 04:06:44 +00:00