Commit 90419ce4 authored by Jason R. Coombs's avatar Jason R. Coombs Committed by GitHub

Merge pull request #957 from smheidrich/fix_hardlinks_via_autosectionlabel

 Fix hard link to URLs that should have been internal (method 2: via autosectionlabel Sphinx extension)
parents e65c4553 e83845ac
...@@ -29,7 +29,7 @@ import setup as setup_script ...@@ -29,7 +29,7 @@ import setup as setup_script
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
......
...@@ -143,10 +143,10 @@ namespace package for Zope Corporation packages, and the ``peak`` namespace ...@@ -143,10 +143,10 @@ namespace package for Zope Corporation packages, and the ``peak`` namespace
package for the Python Enterprise Application Kit. package for the Python Enterprise Application Kit.
To create a namespace package, you list it in the ``namespace_packages`` To create a namespace package, you list it in the ``namespace_packages``
argument to ``setup()``, in your project's ``setup.py``. (See the `setuptools argument to ``setup()``, in your project's ``setup.py``. (See the
documentation on namespace packages`_ for more information on this.) Also, :ref:`setuptools documentation on namespace packages <Namespace Packages>` for
you must add a ``declare_namespace()`` call in the package's ``__init__.py`` more information on this.) Also, you must add a ``declare_namespace()`` call
file(s): in the package's ``__init__.py`` file(s):
``declare_namespace(name)`` ``declare_namespace(name)``
Declare that the dotted package name `name` is a "namespace package" whose 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" ...@@ -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. compatible with PEP 302 using the ``register_namespace_handler()`` function.
See the section below on `Supporting Custom Importers`_ for details. 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 ``WorkingSet`` Objects
====================== ======================
......
...@@ -940,14 +940,13 @@ Typically, existing programs manipulate a package's ``__file__`` attribute in ...@@ -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 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 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, 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 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 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 use its resource management API. See also `Accessing Package Resources`_ for
a quick example of converting code that uses ``__file__`` to use a quick example of converting code that uses ``__file__`` to use
``pkg_resources`` instead. ``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 .. _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 ...@@ -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`` like documentation, example configuration files, and the like. ``setuptools``
does not install these data files in a separate location, however. They are 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 bundled inside the egg file or directory, alongside the Python modules and
packages. The data files can also be accessed using the `Resource Management packages. The data files can also be accessed using the :ref:`ResourceManager
API`_, by specifying a ``Requirement`` instead of a package name:: API`, by specifying a ``Requirement`` instead of a package name::
from pkg_resources import Requirement, resource_filename from pkg_resources import Requirement, resource_filename
filename = resource_filename(Requirement.parse("MyProject"),"sample.conf") filename = resource_filename(Requirement.parse("MyProject"),"sample.conf")
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment