summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBastian Venthur <bastian.venthur@flixbus.com>2019-05-16 10:29:11 +0200
committerBastian Venthur <bastian.venthur@flixbus.com>2019-05-16 10:29:11 +0200
commit46a73d96faedee345834f29a7ac218de64519da2 (patch)
tree7a33a41a452309a6f3a938e4c3e3bd1ccff102dd /docs
parentd307b46c898fa5ee902344dab7ecc6e8ed595987 (diff)
downloadpython-setuptools-git-46a73d96faedee345834f29a7ac218de64519da2.tar.gz
Fixed broken implicit links
Diffstat (limited to 'docs')
-rw-r--r--docs/keywords.txt34
-rw-r--r--docs/setuptools.txt10
2 files changed, 26 insertions, 18 deletions
diff --git a/docs/keywords.txt b/docs/keywords.txt
index a1097aca..6a8fc2f2 100644
--- a/docs/keywords.txt
+++ b/docs/keywords.txt
@@ -9,19 +9,19 @@ associated ``setuptools`` feature.
``include_package_data``
If set to ``True``, this tells ``setuptools`` to automatically include any
data files it finds inside your package directories that are specified by
- your ``MANIFEST.in`` file. For more information, see the section below on
- `Including Data Files`_.
+ your ``MANIFEST.in`` file. For more information, see the section on
+ :ref:`Including Data Files`.
``exclude_package_data``
A dictionary mapping package names to lists of glob patterns that should
be *excluded* from your package directories. You can use this to trim back
any excess files included by ``include_package_data``. For a complete
- description and examples, see the section below on `Including Data Files`_.
+ description and examples, see the section on :ref:`Including Data Files`.
``package_data``
A dictionary mapping package names to lists of glob patterns. For a
- complete description and examples, see the section below on `Including
- Data Files`_. You do not need to use this option if you are using
+ complete description and examples, see the section on :ref:`Including Data
+ Files`. You do not need to use this option if you are using
``include_package_data``, unless you need to add e.g. files that are
generated by your setup script and build process. (And are therefore not
in source control or are files that you don't want to include in your
@@ -35,22 +35,22 @@ associated ``setuptools`` feature.
``install_requires``
A string or list of strings specifying what other distributions need to
- be installed when this one is. See the section below on `Declaring
- Dependencies`_ for details and examples of the format of this argument.
+ be installed when this one is. See the section on :ref:`Declaring
+ Dependencies` for details and examples of the format of this argument.
``entry_points``
A dictionary mapping entry point group names to strings or lists of strings
defining the entry points. Entry points are used to support dynamic
- discovery of services or plugins provided by a project. See `Dynamic
- Discovery of Services and Plugins`_ for details and examples of the format
- of this argument. In addition, this keyword is used to support `Automatic
- Script Creation`_.
+ discovery of services or plugins provided by a project. See :ref:`Dynamic
+ Discovery of Services and Plugins` for details and examples of the format
+ of this argument. In addition, this keyword is used to support
+ :ref:`Automatic Script Creation`.
``extras_require``
A dictionary mapping names of "extras" (optional features of your project)
to strings or lists of strings specifying what other distributions must be
- installed to support those features. See the section below on `Declaring
- Dependencies`_ for details and examples of the format of this argument.
+ installed to support those features. See the section on :ref:`Declaring
+ Dependencies` for details and examples of the format of this argument.
``python_requires``
A string corresponding to a version specifier (as defined in PEP 440) for
@@ -89,7 +89,7 @@ associated ``setuptools`` feature.
as you declare them in each project that contains any subpackages of the
namespace package, and as long as the namespace package's ``__init__.py``
does not contain any code other than a namespace declaration. See the
- section below on `Namespace Packages`_ for more information.
+ section on :ref:`Namespace Packages` for more information.
``test_suite``
A string naming a ``unittest.TestCase`` subclass (or a package or module
@@ -100,9 +100,9 @@ associated ``setuptools`` feature.
added to the tests to be run. If the named suite is a package, any
submodules and subpackages are recursively added to the overall test suite.
- Specifying this argument enables use of the `test`_ command to run the
+ Specifying this argument enables use of the :ref:`test` command to run the
specified test suite, e.g. via ``setup.py test``. See the section on the
- `test`_ command below for more details.
+ :ref:`test` command below for more details.
``tests_require``
If your project's tests need one or more additional packages besides those
@@ -152,7 +152,7 @@ associated ``setuptools`` feature.
extensions that access other files in the project (such as data files or
shared libraries), you probably do NOT need this argument and shouldn't
mess with it. For more details on how this argument works, see the section
- below on `Automatic Resource Extraction`_.
+ below on :ref:`Automatic Resource Extraction`.
``use_2to3``
Convert the source code from Python 2 to Python 3 with 2to3 during the
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 7c0535d0..e07ac296 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -345,6 +345,8 @@ With this layout, the package directory is specified as ``src``, as such::
.. _PEP 420: https://www.python.org/dev/peps/pep-0420/
+.. _Automatic Script Creation:
+
Automatic Script Creation
=========================
@@ -432,6 +434,7 @@ and version is in use. The header script will check this and exit with an
error if the ``.egg`` file has been renamed or is invoked via a symlink that
changes its base name.
+.. _Declaring Dependencies:
Declaring Dependencies
======================
@@ -685,6 +688,8 @@ detailed in `PEP 508`_.
.. _PEP 508: https://www.python.org/dev/peps/pep-0508/
+.. _Including Data Files:
+
Including Data Files
====================
@@ -860,6 +865,7 @@ no supported facility to reliably retrieve these resources.
Instead, the PyPA recommends that any data files you wish to be accessible at
run time be included in the package.
+.. _Automatic Resource Extraction:
Automatic Resource Extraction
-----------------------------
@@ -905,6 +911,8 @@ Extensible Applications and Frameworks
.. _Entry Points:
+.. _Dynamic Discovery of Services and Plugins:
+
Dynamic Discovery of Services and Plugins
-----------------------------------------
@@ -1977,7 +1985,7 @@ result (which must be a ``unittest.TestSuite``) is added to the tests to be
run. If the named suite is a package, any submodules and subpackages are
recursively added to the overall test suite. (Note: if your project specifies
a ``test_loader``, the rules for processing the chosen ``test_suite`` may
-differ; see the `test_loader`_ documentation for more details.)
+differ; see the :ref:`test_loader <test_loader>` documentation for more details.)
Note that many test systems including ``doctest`` support wrapping their
non-``unittest`` tests in ``TestSuite`` objects. So, if you are using a test