Skip to content

docs: add license configuration examples for SDK generators #1755

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 2 commits into from
Nov 5, 2025
+8 −4
Merged

docs: add license configuration examples for SDK generators #1755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd7b294
docs: add license configuration examples for SDK generators
devin-ai-integration[bot] Nov 4, 2025
554602c
clarify metadata info
devalog Nov 5, 2025
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
10 changes: 7 additions & 3 deletions fern/products/sdks/overview/python/publishing-to-pypi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,12 @@ groups:

<Step title="Add PyPI metadata (optional)">

You can add metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package's PyPI page and includes `keywords` for PyPI search and discovery, `documentation-link` for your package documentation, and `homepage-link` for your project homepage.
You can add publishing metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package's PyPI page and includes `keywords` for PyPI search and discovery, `documentation-link` for your package documentation, and `homepage-link` for your project homepage.

You can additionally add general metadata for the SDK (description, contact email, author, license, etc.) at [the individual SDK level](/learn/sdks/reference/generators-yml#metadata-2) or [globally for all SDKs](/learn/sdks/reference/generators-yml#metadata).


```yaml title="generators.yml" {9-12}
```yaml title="generators.yml" {9, 13}
groups:
python-sdk:
generators:
Expand All @@ -96,10 +98,12 @@ groups:
output:
location: pypi
package-name: your-package-name
metadata:
metadata: # Publishing metadata
keywords: ["api", "sdk", "client"]
documentation-link: "https://docs.yourcompany.com"
homepage-link: "https://yourcompany.com"
metadata: # General SDK metadata
license: MIT
config:
client_class_name: YourClientName
```
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/reference/generators-yml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: generators.yml configuration schema
description: Reference for the generators.yml configuration
max-toc-depth: 2
max-toc-depth: 3
---

The `generators.yml` file configures how Fern generates SDKs from your API
Expand Down
Loading