Skip to content

Commit

Permalink
Merge pull request #2552 from hexagonrecursion/patch-1
Browse files Browse the repository at this point in the history
quickstart: recommend PyPA build instead of pep517.build
  • Loading branch information
jaraco authored Feb 28, 2021
2 parents f07e7ea + e70c2af commit dd351c9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,17 @@
),
}

intersphinx_mapping = {
'pypa-build': ('https://pypa-build.readthedocs.io/en/latest/', None)
}

# Add support for linking usernames
github_url = 'https://github.com'
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
Expand Down
6 changes: 3 additions & 3 deletions docs/userguide/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down

0 comments on commit dd351c9

Please sign in to comment.