aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsmheidrich <smheidrich@weltenfunktion.de>2017-02-02 12:32:27 +0100
committersmheidrich <smheidrich@weltenfunktion.de>2017-02-02 12:32:37 +0100
commite83845ac9b23d3e6e397263aa933372148fc5fee (patch)
tree0c6fbe30087f9e2bec14cd49ddaa0fd75d471bc6
parent5a028a7061f37868133d2951ca284d34e253484d (diff)
downloadexternal_python_setuptools-e83845ac9b23d3e6e397263aa933372148fc5fee.tar.gz
external_python_setuptools-e83845ac9b23d3e6e397263aa933372148fc5fee.tar.bz2
external_python_setuptools-e83845ac9b23d3e6e397263aa933372148fc5fee.zip
Added autosectionlabel Sphinx extension and replaced some obsolete links.
-rw-r--r--docs/conf.py2
-rw-r--r--docs/pkg_resources.txt10
-rw-r--r--docs/setuptools.txt7
3 files changed, 8 insertions, 11 deletions
diff --git a/docs/conf.py b/docs/conf.py
index c1854ed8..fe684271 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -29,7 +29,7 @@ import setup as setup_script
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['rst.linker']
+extensions = ['rst.linker', 'sphinx.ext.autosectionlabel']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt
index e8412b33..487320ce 100644
--- a/docs/pkg_resources.txt
+++ b/docs/pkg_resources.txt
@@ -143,10 +143,10 @@ namespace package for Zope Corporation packages, and the ``peak`` namespace
package for the Python Enterprise Application Kit.
To create a namespace package, you list it in the ``namespace_packages``
-argument to ``setup()``, in your project's ``setup.py``. (See the `setuptools
-documentation on namespace packages`_ for more information on this.) Also,
-you must add a ``declare_namespace()`` call in the package's ``__init__.py``
-file(s):
+argument to ``setup()``, in your project's ``setup.py``. (See the
+:ref:`setuptools documentation on namespace packages <Namespace Packages>` for
+more information on this.) Also, you must add a ``declare_namespace()`` call
+in the package's ``__init__.py`` file(s):
``declare_namespace(name)``
Declare that the dotted package name `name` is a "namespace package" whose
@@ -175,8 +175,6 @@ filesystem and zip importers, you can extend its support to other "importers"
compatible with PEP 302 using the ``register_namespace_handler()`` function.
See the section below on `Supporting Custom Importers`_ for details.
-.. _setuptools documentation on namespace packages: http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
-
``WorkingSet`` Objects
======================
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 2a494fca..2c197d98 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -940,14 +940,13 @@ Typically, existing programs manipulate a package's ``__file__`` attribute in
order to find the location of data files. However, this manipulation isn't
compatible with PEP 302-based import hooks, including importing from zip files
and Python Eggs. It is strongly recommended that, if you are using data files,
-you should use the `Resource Management API`_ of ``pkg_resources`` to access
+you should use the :ref:`ResourceManager API` of ``pkg_resources`` to access
them. The ``pkg_resources`` module is distributed as part of setuptools, so if
you're using setuptools to distribute your package, there is no reason not to
use its resource management API. See also `Accessing Package Resources`_ for
a quick example of converting code that uses ``__file__`` to use
``pkg_resources`` instead.
-.. _Resource Management API: http://peak.telecommunity.com/DevCenter/PkgResources#resourcemanager-api
.. _Accessing Package Resources: http://peak.telecommunity.com/DevCenter/PythonEggs#accessing-package-resources
@@ -959,8 +958,8 @@ location (e.g. ``/usr/share``). This feature intended to be used for things
like documentation, example configuration files, and the like. ``setuptools``
does not install these data files in a separate location, however. They are
bundled inside the egg file or directory, alongside the Python modules and
-packages. The data files can also be accessed using the `Resource Management
-API`_, by specifying a ``Requirement`` instead of a package name::
+packages. The data files can also be accessed using the :ref:`ResourceManager
+API`, by specifying a ``Requirement`` instead of a package name::
from pkg_resources import Requirement, resource_filename
filename = resource_filename(Requirement.parse("MyProject"),"sample.conf")