diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-05-09 12:45:10 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2021-05-09 12:45:10 -0400 |
| commit | baf4e6cbbb6abef42f2b297b32d7aa9955c4f004 (patch) | |
| tree | 6a9da9a5326db884d36dc2cf51f3380ffbc8d035 /docs | |
| parent | 5bb42992e2f5cd0d6510056da3576821fc823d2b (diff) | |
| parent | 317ad2c4c9edf793e65372e80ec2d64f4edf147f (diff) | |
| download | python-setuptools-git-baf4e6cbbb6abef42f2b297b32d7aa9955c4f004.tar.gz | |
Merge branch 'main' into docs/towncrier-upgrade
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/userguide/quickstart.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 2807f59b..a9f0bbae 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -22,7 +22,7 @@ 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, -navigate to the `bottom <Resources on python packaging>`_ of this page. +navigate to the :ref:`bottom <packaging-resources>` of this page. Basic Use @@ -52,8 +52,8 @@ the minimum [options] packages = mypackage install_requires = - requests - importlib; python_version == "2.6" + requests + importlib; python_version == "2.6" .. tab:: setup.py @@ -215,13 +215,14 @@ basic use here. Transitioning from ``setup.py`` to ``setup.cfg`` -================================================== +================================================ To avoid executing arbitary scripts and boilerplate code, we are transitioning into a full-fledged ``setup.cfg`` to declare your package information instead of running ``setup()``. This inevitably brings challenges due to a different syntax. Here we provide a quick guide to understanding how ``setup.cfg`` is parsed by ``setuptool`` to ease the pain of transition. +.. _packaging-resources: Resources on Python packaging ============================= |