Skip to content

Commit

Permalink
Recommend build instead of invoking setup.py directly (#439)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Jan 11, 2022
1 parent 0e07002 commit ab82cea
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Quickstart
==========

To build a wheel for your setuptools based project::
To build a wheel for your project::

python setup.py bdist_wheel
python -m pip install build
python -m build --wheel

The wheel will go to ``dist/yourproject-<tags>.whl``.

Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ User Guide
Building Wheels
---------------

Building wheels from a setuptools_ based project is simple::
To build a wheel for your project::

python setup.py bdist_wheel
python -m pip install build
python -m build --wheel

This will build any C extensions in the project and then package those and the
pure Python code into a ``.whl`` file in the ``dist`` directory.
Expand All @@ -20,7 +21,6 @@ adding this to your ``setup.cfg`` file:
[bdist_wheel]
universal = 1
.. _setuptools: https://pypi.org/project/setuptools/
Including license files in the generated wheel file
---------------------------------------------------
Expand Down

0 comments on commit ab82cea

Please sign in to comment.