Skip to content

Commit f674e1b

Browse files
committed
Simplify pyproject.toml section
1 parent ce57755 commit f674e1b

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,9 @@ Creating a test directory
7777
Creating pyproject.toml
7878
-----------------------
7979

80-
:file:`pyproject.toml` is the file that tells build tools (like :ref:`pip` and
81-
:ref:`build`) what system you are using and what is required for building. The
82-
default if this file is missing is to assume a :ref:`setuptools` build system,
83-
but it is better to be explicit; if you have a :file:`pyproject.toml` file, you
84-
will be able to rely on :ref:`wheel` and other packages being present.
85-
86-
This file should be ideal for most :ref:`setuptools` projects:
87-
80+
:file:`pyproject.toml` tells build tools (like :ref:`pip` and :ref:`build`)
81+
what is required to build your project. This tutorial uses :ref:`setuptools`,
82+
so open :file:`pyproject.toml` and enter the following content:
8883

8984
.. code-block:: toml
9085
@@ -100,12 +95,13 @@ This file should be ideal for most :ref:`setuptools` projects:
10095
package. Listing something here will *only* make it available during the build,
10196
not after it is installed.
10297

103-
``build-system.build-backend`` is technically optional, but you will get
104-
``setuptools.build_meta:__legacy__`` instead if you forget to include it, so
105-
always include it. If you were to use a different build system, such as
98+
``build-system.build-backend`` is the name of Python object that will be used to
99+
perform the build. If you were to use a different build system, such as
106100
:ref:`flit` or :ref:`poetry`, those would go here, and the configuration details
107101
would be completely different than the :ref:`setuptools` configuration described
108-
below. See :pep:`517` and :pep:`518` for background and details.
102+
below.
103+
104+
See :pep:`517` and :pep:`518` for background and details.
109105

110106

111107
Configuring metadata

0 commit comments

Comments
 (0)