diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..f13aa7a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,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 |