Skip to content

Commit cfcdf11

Browse files
devin-ai-integration[bot]dannysheridandevalog
authored
docs: add license configuration examples for SDK generators (#1755)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent f4ae1de commit cfcdf11

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

fern/products/sdks/overview/python/publishing-to-pypi.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,12 @@ groups:
8484

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

87-
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.
87+
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.
88+
89+
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).
8890

8991

90-
```yaml title="generators.yml" {9-12}
92+
```yaml title="generators.yml" {9, 13}
9193
groups:
9294
python-sdk:
9395
generators:
@@ -96,10 +98,12 @@ groups:
9698
output:
9799
location: pypi
98100
package-name: your-package-name
99-
metadata:
101+
metadata: # Publishing metadata
100102
keywords: ["api", "sdk", "client"]
101103
documentation-link: "https://docs.yourcompany.com"
102104
homepage-link: "https://yourcompany.com"
105+
metadata: # General SDK metadata
106+
license: MIT
103107
config:
104108
client_class_name: YourClientName
105109
```

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: generators.yml configuration schema
33
description: Reference for the generators.yml configuration
4-
max-toc-depth: 2
4+
max-toc-depth: 3
55
---
66

77
The `generators.yml` file configures how Fern generates SDKs from your API

0 commit comments

Comments
 (0)