Skip to content

Commit 5c30759

Browse files
committed
PEP 517: Fix headers
1 parent 6b50f38 commit 5c30759

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

source/specifications/build-system-interface.rst

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ combination of wheels and sdists. In a command like ``pip install
2424
lxml==2.4.0``, pip is acting as an integration frontend.
2525

2626

27-
==============
28-
Source trees
29-
==============
27+
Source trees
28+
============
3029

3130
There is an existing, legacy source tree format involving
3231
``setup.py``. We don't try to specify it further; its de facto
@@ -128,19 +127,18 @@ Typically this will involve specifying themselves as an in-tree backend, and
128127
avoiding external build dependencies (usually by vendoring them).
129128

130129

131-
=========================
132-
Build backend interface
133-
=========================
130+
Build backend interface
131+
========================
134132

135133
The build backend object is expected to have attributes which provide
136134
some or all of the following hooks. The common ``config_settings``
137135
argument is described after the individual hooks.
138136

139137
Mandatory hooks
140-
===============
138+
---------------
141139

142140
build_wheel
143-
-----------
141+
'''''''''''
144142

145143
::
146144

@@ -181,7 +179,7 @@ temporary directories. The presence or absence of any caches should not
181179
make a material difference to the final result of the build.
182180

183181
build_sdist
184-
-----------
182+
'''''''''''
185183

186184
::
187185

@@ -204,10 +202,10 @@ The backend does not need to define this exception type if it would never raise
204202
it.
205203

206204
Optional hooks
207-
==============
205+
--------------
208206

209207
get_requires_for_build_wheel
210-
----------------------------
208+
''''''''''''''''''''''''''''
211209

212210
::
213211

@@ -227,7 +225,7 @@ Example::
227225
If not defined, the default implementation is equivalent to ``return []``.
228226

229227
prepare_metadata_for_build_wheel
230-
--------------------------------
228+
''''''''''''''''''''''''''''''''
231229

232230
::
233231

@@ -254,7 +252,7 @@ not defined, it should call ``build_wheel`` and look at the resulting
254252
metadata directly.
255253

256254
get_requires_for_build_sdist
257-
----------------------------
255+
''''''''''''''''''''''''''''
258256

259257
::
260258

@@ -281,7 +279,7 @@ If not defined, the default implementation is equivalent to ``return []``.
281279
need from the backend to do so.
282280

283281
Config settings
284-
===============
282+
---------------
285283

286284
::
287285

@@ -342,7 +340,7 @@ then this indicates an error.
342340

343341

344342
Build environment
345-
=================
343+
-----------------
346344

347345
One of the responsibilities of a build frontend is to set up the
348346
Python environment in which the build backend will run.
@@ -399,7 +397,7 @@ working directory). A Python library will be provided which frontends can use
399397
to easily call hooks this way.
400398

401399
Recommendations for build frontends (non-normative)
402-
---------------------------------------------------
400+
'''''''''''''''''''''''''''''''''''''''''''''''''''
403401

404402
A build frontend MAY use any mechanism for setting up a build
405403
environment that meets the above criteria. For example, simply
@@ -454,7 +452,7 @@ hood and apply duct tape when necessary.
454452

455453

456454
In-tree build backends
457-
======================
455+
----------------------
458456

459457
In certain circumstances, projects may wish to include the source code for the
460458
build backend directly in the source tree, rather than referencing the backend
@@ -495,9 +493,8 @@ would typically involve checking the backend's ``__file__`` attribute against
495493
the locations in ``backend-path``.
496494

497495

498-
===============================
499-
Summary of changes to PEP 517
500-
===============================
496+
History
497+
=======
501498

502499
The following changes were made to this PEP after the initial reference
503500
implementation was released in pip 19.0.

0 commit comments

Comments
 (0)