diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2016-06-06 07:23:42 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2016-06-06 07:23:42 -0400 |
| commit | df3905616933c90af95e99f705b800a2f5c1c921 (patch) | |
| tree | f9def47225ce6dd5d88cd51bd7442f3c78aab877 /docs | |
| parent | 48b63f309650af9e43368cf0d6792ea247ad8663 (diff) | |
| parent | f43c0f0651edfe1f52b0a178cfe2a5234a008af0 (diff) | |
| download | python-setuptools-git-df3905616933c90af95e99f705b800a2f5c1c921.tar.gz | |
Merge with master
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 120 | ||||
| -rw-r--r-- | docs/easy_install.txt | 2 | ||||
| -rw-r--r-- | docs/releases.txt | 19 | ||||
| -rw-r--r-- | docs/requirements.txt | 1 | ||||
| -rw-r--r-- | docs/setuptools.txt | 3 |
5 files changed, 72 insertions, 73 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8bba3e94..72c1ce43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -196,64 +196,64 @@ latex_documents = [ #latex_use_modindex = True link_files = { - 'CHANGES.rst': dict( - using=dict( - BB='https://bitbucket.org', - GH='https://github.com', - ), - replace=[ - dict( - pattern=r"(Issue )?#(?P<issue>\d+)", - url='{GH}/pypa/setuptools/issues/{issue}', - ), - dict( - pattern=r"BB Pull Request ?#(?P<bb_pull_request>\d+)", - url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', - ), - dict( - pattern=r"Distribute #(?P<distribute>\d+)", - url='{BB}/tarek/distribute/issue/{distribute}', - ), - dict( - pattern=r"Buildout #(?P<buildout>\d+)", - url='{GH}/buildout/buildout/issues/{buildout}', - ), - dict( - pattern=r"Old Setuptools #(?P<old_setuptools>\d+)", - url='http://bugs.python.org/setuptools/issue{old_setuptools}', - ), - dict( - pattern=r"Jython #(?P<jython>\d+)", - url='http://bugs.jython.org/issue{jython}', - ), - dict( - pattern=r"Python #(?P<python>\d+)", - url='http://bugs.python.org/issue{python}', - ), - dict( - pattern=r"Interop #(?P<interop>\d+)", - url='{GH}/pypa/interoperability-peps/issues/{interop}', - ), - dict( - pattern=r"Pip #(?P<pip>\d+)", - url='{GH}/pypa/pip/issues/{pip}', - ), - dict( - pattern=r"Packaging #(?P<packaging>\d+)", - url='{GH}/pypa/packaging/issues/{packaging}', - ), - dict( - pattern=r"[Pp]ackaging (?P<packaging_ver>\d+(\.\d+)+)", - url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', - ), - dict( - pattern=r"PEP[- ](?P<pep_number>\d+)", - url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', - ), - dict( - pattern=r"^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n", - with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", - ), - ], - ), + '../CHANGES.rst': dict( + using=dict( + BB='https://bitbucket.org', + GH='https://github.com', + ), + replace=[ + dict( + pattern=r"(Issue )?#(?P<issue>\d+)", + url='{GH}/pypa/setuptools/issues/{issue}', + ), + dict( + pattern=r"BB Pull Request ?#(?P<bb_pull_request>\d+)", + url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', + ), + dict( + pattern=r"Distribute #(?P<distribute>\d+)", + url='{BB}/tarek/distribute/issue/{distribute}', + ), + dict( + pattern=r"Buildout #(?P<buildout>\d+)", + url='{GH}/buildout/buildout/issues/{buildout}', + ), + dict( + pattern=r"Old Setuptools #(?P<old_setuptools>\d+)", + url='http://bugs.python.org/setuptools/issue{old_setuptools}', + ), + dict( + pattern=r"Jython #(?P<jython>\d+)", + url='http://bugs.jython.org/issue{jython}', + ), + dict( + pattern=r"Python #(?P<python>\d+)", + url='http://bugs.python.org/issue{python}', + ), + dict( + pattern=r"Interop #(?P<interop>\d+)", + url='{GH}/pypa/interoperability-peps/issues/{interop}', + ), + dict( + pattern=r"Pip #(?P<pip>\d+)", + url='{GH}/pypa/pip/issues/{pip}', + ), + dict( + pattern=r"Packaging #(?P<packaging>\d+)", + url='{GH}/pypa/packaging/issues/{packaging}', + ), + dict( + pattern=r"[Pp]ackaging (?P<packaging_ver>\d+(\.\d+)+)", + url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', + ), + dict( + pattern=r"PEP[- ](?P<pep_number>\d+)", + url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', + ), + dict( + pattern=r"^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n", + with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", + ), + ], + ), } diff --git a/docs/easy_install.txt b/docs/easy_install.txt index 8dd176fd..a66909b1 100644 --- a/docs/easy_install.txt +++ b/docs/easy_install.txt @@ -677,7 +677,7 @@ locations, build options, etc., EasyInstall will respect your existing settings until and unless you override them explicitly in an ``[easy_install]`` section. For more information, see also the current Python documentation on the `use and -location of distutils configuration files <http://docs.python.org/inst/config-syntax.html>`_. +location of distutils configuration files <https://docs.python.org/install/index.html#inst-config-files>`_. Notice that ``easy_install`` will use the ``setup.cfg`` from the current working directory only if it was triggered from ``setup.py`` through the diff --git a/docs/releases.txt b/docs/releases.txt index 3f29334a..c84ddd75 100644 --- a/docs/releases.txt +++ b/docs/releases.txt @@ -10,23 +10,20 @@ successful build of a tagged release per To cut a release, install and run ``bumpversion {part}`` where ``part`` is major, minor, or patch based on the scope of the changes in the release. Then, push the commits to the master branch. If tests pass, -the release will be uploaded to PyPI. +the release will be uploaded to PyPI (from the Python 3.5 tests). -Bootstrap Bookmark ------------------- +Bootstrap Branch +---------------- -Setuptools has a bootstrap script (ez_setup.py) which is hosted in the -repository and must be updated with each release (to bump the default version). -The "published" version of the script is the one indicated by the ``bootstrap`` -branch. +Setuptools has a bootstrap script (ez_setup.py), which is hosted in the +repository in the ``bootstrap`` branch. -Therefore, the latest bootstrap script can be retrieved by checking out the -repository at that bookmark. It's also possible to get the bootstrap script for -any particular release by grabbing the script from that tagged release. +Therefore, the latest bootstrap script can be retrieved by checking out +that branch. The officially-published location of the bootstrap script is hosted on Python infrastructure (#python-infra on freenode) at https://bootstrap.pypa.io and -is updated every fifteen minutes from the bootstrap script. Sometimes, +is updated every fifteen minutes from the bootstrap branch. Sometimes, especially when the bootstrap script is rolled back, this process doesn't work as expected and requires manual intervention. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..0871ed76 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +rst.linker>=1.6.1 diff --git a/docs/setuptools.txt b/docs/setuptools.txt index eeeab937..57818281 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -1270,7 +1270,8 @@ Creating System Packages Setting the ``zip_safe`` flag ----------------------------- -For maximum performance, Python packages are best installed as zip files. +For some use cases (such as bundling as part of a larger application), Python +packages may be run directly from a zip file. Not all packages, however, are capable of running in compressed form, because they may expect to be able to access either source code or data files as normal operating system files. So, ``setuptools`` can install your project |
