Skip to content

Conversation

girdharagrawalbro
Copy link
Contributor

@girdharagrawalbro girdharagrawalbro commented Oct 16, 2025

Adds documentation for poetry build command.

Examples included:

  • Build package in both formats (wheel and sdist)
  • Build only wheel format
  • Build only sdist format
  • Build with verbose output
  • Build using specific format

#18042

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 16, 2025
@dmmqz dmmqz mentioned this pull request Oct 16, 2025
28 tasks

- Build only the wheel package:

`poetry build --format {{wheel}}`
Copy link
Member

@dmmqz dmmqz Oct 16, 2025

Choose a reason for hiding this comment

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

Suggested change
`poetry build --format {{wheel}}`
`poetry build {{[-f|--format]}} wheel`


- Build only the source distribution (sdist):

`poetry build --format {{sdist}}`
Copy link
Member

@dmmqz dmmqz Oct 16, 2025

Choose a reason for hiding this comment

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

Suggested change
`poetry build --format {{sdist}}`
`poetry build {{[-f|--format]}} sdist`


- Build the package and output to a specific directory:

`poetry build --output {{path/to/directory}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`poetry build --output {{path/to/directory}}`
`poetry build {{[-o|--output]}} {{path/to/directory}}`


- Display help:

`poetry build --help`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`poetry build --help`
`poetry build {{[-h|--help]}}`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants