From 717af2c330083f223fc1a5b33bebbbe893097eaf Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Thu, 14 Nov 2024 12:05:54 +0100 Subject: [PATCH] DOC: minor tweak to docs on invoking pip/build Addresses a comment on issue 704, where a user got tripped up by `python -m build` building an sdist first (and that's typically not what you want). --- docs/how-to-guides/config-settings.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/how-to-guides/config-settings.rst b/docs/how-to-guides/config-settings.rst index 75b02a81b..72b4ea361 100644 --- a/docs/how-to-guides/config-settings.rst +++ b/docs/how-to-guides/config-settings.rst @@ -24,7 +24,7 @@ the ``-C`` short command line option: .. code-block:: console - $ python -m build \ + $ python -m build --wheel \ -Csetup-args="-Doption=true" \ -Csetup-args="-Dvalue=1" \ -Ccompile-args="-j6" @@ -34,6 +34,7 @@ the ``-C`` short command line option: .. code-block:: console + $ # note: pip >=23.1 also accepts -C instead of --config-settings $ python -m pip wheel . \ --config-settings=setup-args="-Doption=disable" \ --config-settings=compile-args="-j6"