Skip to content

docs: drop the invented --srcdir option from the basic-usage how-to #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hxperl wants to merge 3 commits into
base: main
Choose a base branch
from
+2 −5
Open

docs: drop the invented --srcdir option from the basic-usage how-to #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
012984e
docs: drop the invented --srcdir option from the basic-usage how-to
hxperl Sep 11, 2026
6a8eecc
docs: add changelog fragment for #1186
hxperl Sep 11, 2026
e47f6d5
Shorten the changelog fragment to satisfy docstrfmt
hxperl Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog/1186.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove the ``--srcdir`` option from the basic usage how-to; there is no such option - by :user:`hxperl`
6 changes: 1 addition & 5 deletions docs/how-to/basic-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,7 @@ Build defaults to the current directory. To build from a different location:

$ python -m build path/to/project

Or explicitly:

.. code-block:: console

$ python -m build --srcdir path/to/project
The source directory is positional; there is no option form.

@henryiii henryiii Sep 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this line too, as long as we don't indicate it that it's optional, I don't think we need to state it.


*************************************
Building from a source distribution
Expand Down
Loading