Skip to content

fix(python-sdk): updated docs for pyproject_toml flag #648

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

Merged
merged 1 commit into from
Sep 3, 2025
Merged

fix(python-sdk): updated docs for pyproject_toml flag #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion fern/products/sdks/overview/python/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,18 @@ groups:
</ParamField>

<ParamField path="pyproject_toml" type="string" default="null" required={false} toc={true}>
Path to a custom `pyproject.toml` template file to use instead of the default generated one.
Allow specifying arbitrary configuration to your packages `pyproject.toml` by adding a `pyproject_toml` block to your configuration
whatever you include in this block will be added as-is to the `pyproject.toml` file. The config, as an example is:
Comment on lines +136 to +137
Copy link
Collaborator

@devalog devalog Aug 29, 2025

Choose a reason for hiding this comment

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

Suggested change
Allow specifying arbitrary configuration to your packages `pyproject.toml` by adding a `pyproject_toml` block to your configuration
whatever you include in this block will be added as-is to the `pyproject.toml` file. The config, as an example is:
Allow specifying arbitrary configuration for your package's `pyproject.toml` by adding a `pyproject_toml` block to your configuration. Whatever you include in this block will be added as-is to the `pyproject.toml` file. Example configuration:

```yaml
config:
pyproject_toml: |
[tool.covcheck.group.unit.coverage]
branch = 26.0
line = 62.0
[tool.covcheck.group.service.coverage]
branch = 30.0
line = 67.0
```
</ParamField>

<ParamField path="should_generate_websocket_clients" type="bool" default="false" required={false} toc={true}>
Expand Down
Loading