Commit Graph

29 Commits

Author SHA1 Message Date
Éric Araujo 4d4b19e294 Document that packaging doesn’t create __init__.py files (#3902).
The bug reported expected distutils to create an __init__.py file for a
project using only C extension modules.  IMO, how Python imports
packages and submodules is well documented, and it’s never suggested
that distutils might create an __init__.py file, so I’m adding this
clarification to the packaging docs but won’t backport unless other
people tell me they shared the same wrong expectation.

Thanks to Mike Hoy for his help with the patch.
2011-10-21 07:34:00 +02:00
Éric Araujo 79d9c42b04 Add reST targets to sections of the setup.cfg spec, improve wording 2011-10-19 08:41:07 +02:00
Brett Cannon 5c9a8d0908 Minor grammar fix. 2011-09-05 21:08:14 -07:00
Éric Araujo d9299e97ab Minor improvement to extensions in setup.cfg: check parent package 2011-09-01 07:01:13 +02:00
Éric Araujo 336b4e4ff3 Minor improvement to extensions section in setup.cfg.
The right-hand part in [extension: foo] is now used as the name of the
extension module.  (I changed the separator from = to : and allowed
whitespace to make the sections look nicer.)
2011-09-01 06:29:11 +02:00
Éric Araujo 83ab3f319b Remove obsolete mentions of the compress program and .Z archives.
Packaging uses the shutil.make_archive function copied from distutils,
which does not support compress.  There is no test to check that
“bdist --format whatever” works, so this slipped by.
2011-08-30 01:19:02 +02:00
Éric Araujo 7dc76fdeb1 Merge doc changes from 3.2 (#8617, #10745).
In the install and library docs, I changed the text to refer to
packaging instead of distutils.  I also checked that the documented
paths correctly reflect what’s really defined in sysconfig; the main
difference with paths defined in distutils.install is that include
directories don’t end with the distribution name anymore (i.e. distutils
uses include/python3.3/spam, sysconfig include/python3.3), I have no
idea why.
2011-08-06 16:58:15 +02:00
R David Murray 677b6530b0 Fix English in packaging, too. 2011-07-18 12:39:18 -04:00
Georg Brandl d3b41c63a6 Fix syntax in packaging docs and update suspicious ignore file. 2011-07-09 11:48:50 +02:00
Éric Araujo 54bb1e6aaf Improve documentation of packaging hooks 2011-06-19 21:34:16 +02:00
Éric Araujo 643cb7345f Allow multiple setup hooks in packaging’s setup.cfg files (#12240).
Original patch by Erik Bray.
2011-06-11 00:33:38 +02:00
Éric Araujo 8474f2901b setup.cfg: Document that description-file can contain more than one file 2011-06-11 00:21:18 +02:00
Éric Araujo c7f9f2bfc7 Document how to define extension modules in setup.cfg 2011-06-09 08:18:17 +02:00
Éric Araujo a462a80722 Fix incorrect nesting of sections in setup.cfg specification 2011-06-09 08:15:47 +02:00
Éric Araujo fdeb8bf292 Fix documentation of requires-python field in setup.cfg (#11041) 2011-06-06 19:57:02 +02:00
Éric Araujo a69ade81be Rephrase the section about spec versioning 2011-06-06 02:02:34 +02:00
Éric Araujo 60533e03e9 Fix a few typos 2011-06-06 02:00:54 +02:00
Éric Araujo 1cf8a3203d Minor rework of the extensibility and acks sections 2011-06-06 02:00:03 +02:00
Éric Araujo 8a4e7a9e2c Move a non-PEP 345 field at the end of the metadata fields list 2011-06-06 01:58:54 +02:00
Éric Araujo 1389008022 Make example of file inclusion in setupcfg more obvious 2011-06-06 01:58:25 +02:00
Éric Araujo ed4fd704aa Rephrase and update intro and syntax sections of setupcfg 2011-06-06 02:07:24 +02:00
Éric Araujo 0300b5c9e6 Change reST targets in setup.cfg spec.
I chose “setupcfg” as prefix instead of “packaging-setupcfg” because the scope
of the spec is not limited to packaging: it’s intended as a language-agnostic
document for packaging tools developers as well as Python authors.
2011-06-06 01:54:54 +02:00
Éric Araujo f0f9b22459 Add a short table of contents to the setup.cfg spec.
I tried shortening the sidebar ToC with the tocdepth option instead, but it has
a bug which caused all headings with a level deeper than the tocdepth value to
all have the same section number, which was a usability regression rather than
in improvement.
2011-06-06 01:52:37 +02:00
Éric Araujo 823759e767 Add reST target for Doc/packaging/setupcfg 2011-06-04 18:46:25 +02:00
Éric Araujo ba661a9c39 Add missing section of doc file lost among repositories and conversions 2011-06-04 02:31:14 +02:00
Éric Araujo acf71b89ff Merge packaging doc fix 2011-06-02 16:43:25 +02:00
Tarek Ziade ab244398ba this documentation is now handled by all the new packaging contributors 2011-06-02 11:28:07 +02:00
Éric Araujo 5da37be7f2 Kill trailing whitespace 2011-06-01 20:44:40 +02:00
Éric Araujo 3a9f58f6b3 Add documentation for the packaging module.
This updates the user guide to refer to Packaging instead of Distutils.
Some files still require an update.
2011-06-01 20:42:49 +02:00