diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-02-28 16:48:58 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-28 16:48:58 -0500 |
| commit | dd351c93d75b8670836dcd118452adf8a211081a (patch) | |
| tree | 4bfebf043916795f64ac63a568f89d3e1d946cce | |
| parent | f07e7ea59a484f4e7c2d5c8c6def50c836af334a (diff) | |
| parent | e70c2afc1868a7d9bb2e2887ebf19f6c84dcf283 (diff) | |
| download | python-setuptools-git-dd351c93d75b8670836dcd118452adf8a211081a.tar.gz | |
Merge pull request #2552 from hexagonrecursion/patch-1
quickstart: recommend PyPA build instead of pep517.build
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 6 |
2 files changed, 7 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 18cd7bdc..0a5136b0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,6 +73,9 @@ link_files = { ), } +intersphinx_mapping = { + 'pypa-build': ('https://pypa-build.readthedocs.io/en/latest/', None) +} # Add support for linking usernames github_url = 'https://github.com' @@ -80,7 +83,7 @@ github_sponsors_url = f'{github_url}/sponsors' extlinks = { 'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323 } -extensions += ['sphinx.ext.extlinks'] +extensions += ['sphinx.ext.extlinks', 'sphinx.ext.intersphinx'] # Be strict about any broken references: nitpicky = True diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 1d557d47..e7594ba3 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -59,11 +59,11 @@ This is what your project would look like:: setup.cfg mypackage/__init__.py -Then, you need an installer, such as `pep517 <https://pypi.org/project/pep517/>`_ -which you can obtain via ``pip install pep517``. After downloading it, invoke +Then, you need an installer, such as :std:doc:`PyPA build <pypa-build:index>` +which you can obtain via ``pip install build``. After downloading it, invoke the installer:: - python -m pep517.build . + python -m build You now have your distribution ready (e.g. a ``tar.gz`` file and a ``.whl`` file in the ``dist`` directory), which you can upload to PyPI! |
