diff options
Diffstat (limited to 'docs/userguide/keywords.rst')
| -rw-r--r-- | docs/userguide/keywords.rst | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/userguide/keywords.rst b/docs/userguide/keywords.rst index e2852b34..58fe74bc 100644 --- a/docs/userguide/keywords.rst +++ b/docs/userguide/keywords.rst @@ -8,19 +8,19 @@ unless you need the 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 @@ -34,22 +34,22 @@ unless you need the 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 <entry_points>`. ``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 @@ -87,7 +87,7 @@ unless you need the 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 below on :ref:`Namespace Packages` for more information. ``test_suite`` A string naming a ``unittest.TestCase`` subclass (or a package or module @@ -98,9 +98,9 @@ unless you need the 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 <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 <test>` command below for more details. New in 41.5.0: Deprecated the test command. @@ -155,21 +155,21 @@ unless you need the 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 - build process. See :doc:`python3` for more details. + build process. See :doc:`../deprecated/python3` for more details. ``convert_2to3_doctests`` List of doctest source files that need to be converted with 2to3. - See :doc:`python3` for more details. + See :doc:`../deprecated/python3` for more details. ``use_2to3_fixers`` A list of modules to search for additional fixers to be used during - the 2to3 conversion. See :doc:`python3` for more details. + the 2to3 conversion. See :doc:`../deprecated/python3` for more details. ``project_urls`` An arbitrary map of URL names to hyperlinks, allowing more extensible documentation of where various resources can be found than the simple - ``url`` and ``download_url`` options provide.
\ No newline at end of file + ``url`` and ``download_url`` options provide. |