aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2014-09-29 21:14:51 -0400
committerJason R. Coombs <jaraco@jaraco.com>2014-09-29 21:14:51 -0400
commit626fa69fb0470710e870628afd0cb7ec0ba96ddf (patch)
treebefcacc09c560133266eb5a1757a45ea43d93453 /docs
parent96aed21b42121acde68dd6b3732c3fbae0903569 (diff)
parent9e7f35fec4178dea678693cb768b6076d45e7ddd (diff)
downloadexternal_python_setuptools-626fa69fb0470710e870628afd0cb7ec0ba96ddf.tar.gz
external_python_setuptools-626fa69fb0470710e870628afd0cb7ec0ba96ddf.tar.bz2
external_python_setuptools-626fa69fb0470710e870628afd0cb7ec0ba96ddf.zip
Merge with 6.0.2
--HG-- branch : feature/issue-229
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py11
-rw-r--r--docs/easy_install.txt8
-rw-r--r--docs/formats.txt4
-rw-r--r--docs/merge-faq.txt2
-rw-r--r--docs/pkg_resources.txt6
-rw-r--r--docs/python3.txt2
-rw-r--r--docs/releases.txt2
-rw-r--r--docs/setuptools.txt8
8 files changed, 23 insertions, 20 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 9929aaf6..8be5c3dd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,14 +12,17 @@
# autogenerated file.
#
# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import setup as setup_script
+# serve to show the default
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+
+# Allow Sphinx to find the setup command that is imported below, as referenced above.
+import sys, os
+sys.path.append(os.path.abspath('..'))
+
+import setup as setup_script
# -- General configuration -----------------------------------------------------
diff --git a/docs/easy_install.txt b/docs/easy_install.txt
index 6739ba16..8dd176fd 100644
--- a/docs/easy_install.txt
+++ b/docs/easy_install.txt
@@ -39,7 +39,7 @@ You will need at least Python 2.6. An ``easy_install`` script will be
installed in the normal location for Python scripts on your platform.
Note that the instructions on the setuptools PyPI page assume that you are
-are installling to Python's primary ``site-packages`` directory. If this is
+are installing to Python's primary ``site-packages`` directory. If this is
not the case, you should consult the section below on `Custom Installation
Locations`_ before installing. (And, on Windows, you should not use the
``.exe`` installer when installing to an alternate location.)
@@ -915,7 +915,7 @@ Command-Line Options
domain. The glob patterns must match the *entire* user/host/port section of
the target URL(s). For example, ``*.python.org`` will NOT accept a URL
like ``http://python.org/foo`` or ``http://www.python.org:8080/``.
- Multiple patterns can be specified by separting them with commas. The
+ Multiple patterns can be specified by separating them with commas. The
default pattern is ``*``, which matches anything.
In general, this option is mainly useful for blocking EasyInstall's web
@@ -1014,7 +1014,7 @@ application, simply set the OS environment of that application to a specific val
Use "virtualenv"
~~~~~~~~~~~~~~~~
"virtualenv" is a 3rd-party python package that effectively "clones" a python installation, thereby
-creating an isolated location to intall packages. The evolution of "virtualenv" started before the existence
+creating an isolated location to install packages. The evolution of "virtualenv" started before the existence
of the User installation scheme. "virtualenv" provides a version of ``easy_install`` that is
scoped to the cloned python install and is used in the normal way. "virtualenv" does offer various features
that the User installation scheme alone does not provide, e.g. the ability to hide the main python site-packages.
@@ -1171,7 +1171,7 @@ History
* Fixed not HTML-decoding URLs scraped from web pages
0.6c5
- * Fixed ``.dll`` files on Cygwin not having executable permisions when an egg
+ * Fixed ``.dll`` files on Cygwin not having executable permissions when an egg
is installed unzipped.
0.6c4
diff --git a/docs/formats.txt b/docs/formats.txt
index 36954bef..5c461ecb 100644
--- a/docs/formats.txt
+++ b/docs/formats.txt
@@ -349,7 +349,7 @@ of the project's "traditional" scripts (i.e., those specified using the
``scripts`` keyword to ``setup()``). This is so that they can be
reconstituted when an ``.egg`` file is installed.
-The scripts are placed here using the disutils' standard
+The scripts are placed here using the distutils' standard
``install_scripts`` command, so any ``#!`` lines reflect the Python
installation where the egg was built. But instead of copying the
scripts to the local script installation directory, EasyInstall writes
@@ -595,7 +595,7 @@ order to one another that is defined by their ``PYTHONPATH`` and
The net result of these changes is that ``sys.path`` order will be
as follows at runtime:
-1. The ``sys.argv[0]`` directory, or an emtpy string if no script
+1. The ``sys.argv[0]`` directory, or an empty string if no script
is being executed.
2. All eggs installed by EasyInstall in any ``.pth`` file in each
diff --git a/docs/merge-faq.txt b/docs/merge-faq.txt
index 52013098..ea45f30c 100644
--- a/docs/merge-faq.txt
+++ b/docs/merge-faq.txt
@@ -58,7 +58,7 @@ Who is invited to contribute? Who is excluded?
While we've worked privately to initiate this merge due to the potential sensitivity of the topic, no one is excluded from this effort. We invite all members of the community, especially those most familiar with Python packaging and its challenges to join us in the effort.
-We have lots of ideas for how we'd like to improve the codebase, release process, everything. Like distribute, the post-merge setuptools will have its source hosted on bitbucket. (So if you're currently a distribute contributor, about the only thing that's going to change is the URL of the repository you follow.) Also like distribute, it'll support Python 3, and hopefully we'll soon merge Vinay Sajip's patches to make it run on Python 3 without needing 2to3 to be run on the code first.
+We have lots of ideas for how we'd like to improve the codebase, release process, everything. Like distribute, the post-merge setuptools will have its source hosted on Bitbucket. (So if you're currently a distribute contributor, about the only thing that's going to change is the URL of the repository you follow.) Also like distribute, it'll support Python 3, and hopefully we'll soon merge Vinay Sajip's patches to make it run on Python 3 without needing 2to3 to be run on the code first.
While we've worked privately to initiate this merge due to the potential sensitivity of the topic, no one is excluded from this effort. We invite all members of the community, especially those most familiar with Python packaging and its challenges to join us in the effort.
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt
index 18b68db7..f4a768e4 100644
--- a/docs/pkg_resources.txt
+++ b/docs/pkg_resources.txt
@@ -62,7 +62,7 @@ importable distribution
pluggable distribution
An importable distribution whose filename unambiguously identifies its
- release (i.e. project and version), and whose contents unamabiguously
+ release (i.e. project and version), and whose contents unambiguously
specify what releases of other projects will satisfy its runtime
requirements.
@@ -1434,7 +1434,7 @@ shown here. The `manager` argument to the methods below must be an object
that supports the full `ResourceManager API`_ documented above.
``get_resource_filename(manager, resource_name)``
- Return a true filesystem path for `resource_name`, co-ordinating the
+ Return a true filesystem path for `resource_name`, coordinating the
extraction with `manager`, if the resource must be unpacked to the
filesystem.
@@ -1586,7 +1586,7 @@ Parsing Utilities
character is ``#`` are considered comment lines.)
If `strs` is not an instance of ``basestring``, it is iterated over, and
- each item is passed recursively to ``yield_lines()``, so that an arbitarily
+ each item is passed recursively to ``yield_lines()``, so that an arbitrarily
nested sequence of strings, or sequences of sequences of strings can be
flattened out to the lines contained therein. So for example, passing
a file object or a list of strings to ``yield_lines`` will both work.
diff --git a/docs/python3.txt b/docs/python3.txt
index 1e019951..df173000 100644
--- a/docs/python3.txt
+++ b/docs/python3.txt
@@ -69,7 +69,7 @@ before you run the test command, as the files otherwise will seem updated,
and no conversion will happen.
In general, if code doesn't seem to be converted, deleting the build directory
-and trying again is a good saferguard against the build directory getting
+and trying again is a good safeguard against the build directory getting
"out of sync" with the source directory.
Distributing Python 3 modules
diff --git a/docs/releases.txt b/docs/releases.txt
index 41a814bc..66c0896f 100644
--- a/docs/releases.txt
+++ b/docs/releases.txt
@@ -10,7 +10,7 @@ module. The script does some checks (some interactive) and fully automates
the release process.
A Setuptools release manager must have maintainer access on PyPI to the
-project and administrative access to the BitBucket project.
+project and administrative access to the Bitbucket project.
To make a release, run the following from a Mercurial checkout at the
revision slated for release::
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index a793af53..c3844cf2 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -479,7 +479,7 @@ script called ``baz``, you might do something like this::
'bar = other_module:some_func',
],
'gui_scripts': [
- 'baz = my_package_gui.start_func',
+ 'baz = my_package_gui:start_func',
]
}
)
@@ -520,7 +520,7 @@ as the following::
}
)
-Any eggs built from the above setup script will include a short excecutable
+Any eggs built from the above setup script will include a short executable
prelude that imports and calls ``main_func()`` from ``my_package.some_module``.
The prelude can be run on Unix-like platforms (including Mac and Linux) by
invoking the egg with ``/bin/sh``, or by enabling execute permissions on the
@@ -2180,7 +2180,7 @@ for future builds (even those run implicitly by the ``install`` command)::
setup.py build --compiler=mingw32 saveopts
-The ``saveopts`` command saves all options for every commmand specified on the
+The ``saveopts`` command saves all options for every command specified on the
command line to the project's local ``setup.cfg`` file, unless you use one of
the `configuration file options`_ to change where the options are saved. For
example, this command does the same as above, but saves the compiler setting
@@ -2350,7 +2350,7 @@ Note, by the way, that the metadata in your ``setup()`` call determines what
will be listed in PyPI for your package. Try to fill out as much of it as
possible, as it will save you a lot of trouble manually adding and updating
your PyPI listings. Just put it in ``setup.py`` and use the ``register``
-comamnd to keep PyPI up to date.
+command to keep PyPI up to date.
The ``upload`` command has a few options worth noting: