summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: f13aa7aee20e4f383bdaa15953acce81e01873b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
:hide-toc:

*****
build
*****

A simple, correct :pep:`517` build frontend.

build will invoke the :pep:`517` hooks to build a distribution package.
It is a simple build tool and does not perform any dependency management.

.. sphinx_argparse_cli::
  :module: build.__main__
  :func: main_parser
  :prog: python -m build
  :title: python -m build
  :usage_width: 97

.. note::

   A ``pyproject-build`` CLI script is also available, so that tools such as pipx_
   can use it.

By default build will build the package in an isolated
environment, but this behavior can be disabled with ``--no-isolation``.

.. toctree::
   :hidden:

   mission
   differences

.. toctree::
   :caption: Usage
   :hidden:

   installation
   changelog
   api

.. toctree::
   :caption: Contributing
   :hidden:

   test_suite

.. toctree::
   :caption: Project Links
   :hidden:

   Source Code <https://github.com/pypa/build/>
   Issue Tracker <https://github.com/pypa/build/issues>

.. _pipx: https://github.com/pipxproject/pipx