Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

Commit 501aa80

Browse files
quickstart: recommend PyPA build instead of pep517.build
see pypa/pyproject-hooks#91
1 parent c121d28 commit 501aa80

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

docs/conf.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker']
1+
extensions = [
2+
'sphinx.ext.autodoc',
3+
'jaraco.packaging.sphinx',
4+
'rst.linker',
5+
'sphinx.ext.intersphinx',
6+
'sphinx.ext.extlinks',
7+
]
28

39
master_doc = "index"
410

@@ -73,14 +79,16 @@
7379
),
7480
}
7581

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

7786
# Add support for linking usernames
7887
github_url = 'https://github.com'
7988
github_sponsors_url = f'{github_url}/sponsors'
8089
extlinks = {
8190
'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323
8291
}
83-
extensions += ['sphinx.ext.extlinks']
8492

8593
# Be strict about any broken references:
8694
nitpicky = True

docs/userguide/quickstart.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ This is what your project would look like::
5959
setup.cfg
6060
mypackage/__init__.py
6161

62-
Then, you need an installer, such as `pep517 <https://pypi.org/project/pep517/>`_
63-
which you can obtain via ``pip install pep517``. After downloading it, invoke
62+
Then, you need an installer, such as :std:doc:`PyPA build <pypa-build:index>`_
63+
which you can obtain via ``pip install build``. After downloading it, invoke
6464
the installer::
6565

66-
python -m pep517.build .
66+
python -m build
6767

6868
You now have your distribution ready (e.g. a ``tar.gz`` file and a ``.whl``
6969
file in the ``dist`` directory), which you can upload to PyPI!

0 commit comments

Comments
 (0)