summaryrefslogtreecommitdiff
path: root/docs/userguide/quickstart.rst
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2020-10-17 11:54:14 -0400
committerJason R. Coombs <jaraco@jaraco.com>2020-10-17 11:54:14 -0400
commitb7c83dad9e11fbbc2a69fcc5fc26d4c7d1f5551f (patch)
tree6e44ffdf5ee615d3a845106e3a51c172b2dedce0 /docs/userguide/quickstart.rst
parentb66e45a90e82c9170cc48f21e4dac9d206193953 (diff)
parent61e61296d9537c3e82516611ec283e42b1ed0466 (diff)
downloadpython-setuptools-git-b7c83dad9e11fbbc2a69fcc5fc26d4c7d1f5551f.tar.gz
Merge branch 'master' into patch-1
Diffstat (limited to 'docs/userguide/quickstart.rst')
-rw-r--r--docs/userguide/quickstart.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst
index a07afae7..aebcf60f 100644
--- a/docs/userguide/quickstart.rst
+++ b/docs/userguide/quickstart.rst
@@ -21,8 +21,7 @@ the backend (build system) it wants to use. The distribution can then
be generated with whatever tools that provides a ``build sdist``-alike
functionality. While this may appear cumbersome, given the added pieces,
it in fact tremendously enhances the portability of your package. The
-change is driven under :pep:`PEP 517 <517#build-requirements>`_.
-To learn more about Python packaging in general,
+change is driven under :pep:`517 <517#build-requirements>`. To learn more about Python packaging in general,
navigate to the `bottom <Resources on python packaging>`_ of this page.
@@ -82,8 +81,8 @@ Automatic package discovery
For simple projects, it's usually easy enough to manually add packages to
the ``packages`` keyword in ``setup.cfg``. However, for very large projects
, it can be a big burden to keep the package list updated. ``setuptools``
-therefore provides two convenient tools to ease the burden: ``find: `` and
-``find_namespace: ``. To use it in your project:
+therefore provides two convenient tools to ease the burden: :literal:`find:\ ` and
+:literal:`find_namespace:\ `. To use it in your project:
.. code-block:: ini
@@ -122,7 +121,7 @@ keyword in your ``setup.cfg``:
When this project is installed, a ``main`` script will be installed and will
invoke the ``some_func`` in the ``__init__.py`` file when called by the user.
For detailed usage, including managing the additional or optional dependencies,
-go to :ref:`entry_point`.
+go to :doc:`entry_point`.
Dependency management
@@ -147,9 +146,11 @@ additional keywords such as ``setup_requires`` that allows you to install
dependencies before running the script, and ``extras_requires`` that take
care of those needed by automatically generated scripts. It also provides
mechanisms to handle dependencies that are not in PyPI. For more advanced use,
-see :ref:`dependency_management`
+see :doc:`dependency_management`
+.. _Including Data Files:
+
Including Data Files
====================
The distutils have traditionally allowed installation of "data files", which
@@ -164,7 +165,7 @@ can simply use the ``include_package_data`` keyword:
This tells setuptools to install any data files it finds in your packages.
The data files must be specified via the distutils' ``MANIFEST.in`` file.
-For more details, see :ref:`datafiles`
+For more details, see :doc:`datafiles`
Development mode