diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-20 09:31:35 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-06-20 09:31:35 +0100 |
| commit | c2eac599d22e77e0d44ecd0a43dcc1ec22a285b5 (patch) | |
| tree | ce5cfb8cc61d1f1c9f5e22a7a6ad5079cf83334f /docs/userguide | |
| parent | 7514c6a00f1a0cbaa970eda58709823b61b9399c (diff) | |
| download | python-setuptools-git-c2eac599d22e77e0d44ecd0a43dcc1ec22a285b5.tar.gz | |
[Docs] package discovery guide: Small improvements and fixes
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/package_discovery.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst index 5732b6bc..93419a24 100644 --- a/docs/userguide/package_discovery.rst +++ b/docs/userguide/package_discovery.rst @@ -8,12 +8,11 @@ Package Discovery and Namespace Packages a full specification for the keywords supplied to ``setup.cfg`` or ``setup.py`` can be found at :doc:`keywords reference </references/keywords>` -.. note:: - the examples provided here are only to demonstrate the functionality +.. important:: + The examples provided here are only to demonstrate the functionality introduced. More metadata and options arguments need to be supplied if you want to replicate them on your system. If you are completely - new to setuptools, the :doc:`quickstart section <quickstart>` is a good - place to start. + new to setuptools, the :doc:`quickstart` section is a good place to start. ``Setuptools`` provides powerful tools to handle package discovery, including support for namespace packages. @@ -128,9 +127,8 @@ the following sections. Automatic discovery =================== -.. warning:: Automatic discovery is an **beta** feature and might change - (or be completely removed) in the future. - See :ref:`custom-discovery` for a stable way of configuring ``setuptools``. +.. warning:: Automatic discovery is a **beta** feature and might change in the future. + See :ref:`custom-discovery` for other methods of discovery. By default ``setuptools`` will consider 2 popular project layouts, each one with its own set of advantages and disadvantages [#layout1]_ [#layout2]_ as |