Skip to content

Commit 5fc425a

Browse files
committed
Add link to documentation to pyproject.toml
This way it will be displayed in https://pypi.org/. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent d0e5a86 commit 5fc425a

File tree

8 files changed

+8
-1
lines changed

8 files changed

+8
-1
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
### Cookiecutter template
2020

21-
<!-- Here new features for cookiecutter specifically -->
21+
- Show a link to the documentation in PyPI.
2222

2323
## Bug Fixes
2424

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ dev = [
111111
]
112112

113113
[project.urls]
114+
Documentation = "https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.github_repo_name}}/"
114115
Changelog = "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}/releases"
115116
Issues = "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}/issues"
116117
Repository = "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_repo_name}}"

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ dev = [
112112
]
113113

114114
[project.urls]
115+
Documentation = "https://frequenz-floss.github.io/frequenz-repo-config-python/"
115116
Changelog = "https://github.com/frequenz-floss/frequenz-repo-config-python/releases"
116117
Issues = "https://github.com/frequenz-floss/frequenz-repo-config-python/issues"
117118
Repository = "https://github.com/frequenz-floss/frequenz-repo-config-python"

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ dev = [
8888
]
8989

9090
[project.urls]
91+
Documentation = "https://frequenz-floss.github.io/frequenz-actor-test/"
9192
Changelog = "https://github.com/frequenz-floss/frequenz-actor-test/releases"
9293
Issues = "https://github.com/frequenz-floss/frequenz-actor-test/issues"
9394
Repository = "https://github.com/frequenz-floss/frequenz-actor-test"

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ dev = [
8484
]
8585

8686
[project.urls]
87+
Documentation = "https://frequenz-floss.github.io/frequenz-api-test/"
8788
Changelog = "https://github.com/frequenz-floss/frequenz-api-test/releases"
8889
Issues = "https://github.com/frequenz-floss/frequenz-api-test/issues"
8990
Repository = "https://github.com/frequenz-floss/frequenz-api-test"

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ dev = [
8787
]
8888

8989
[project.urls]
90+
Documentation = "https://frequenz-floss.github.io/frequenz-app-test/"
9091
Changelog = "https://github.com/frequenz-floss/frequenz-app-test/releases"
9192
Issues = "https://github.com/frequenz-floss/frequenz-app-test/issues"
9293
Repository = "https://github.com/frequenz-floss/frequenz-app-test"

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ dev = [
8484
]
8585

8686
[project.urls]
87+
Documentation = "https://frequenz-floss.github.io/frequenz-test-python/"
8788
Changelog = "https://github.com/frequenz-floss/frequenz-test-python/releases"
8889
Issues = "https://github.com/frequenz-floss/frequenz-test-python/issues"
8990
Repository = "https://github.com/frequenz-floss/frequenz-test-python"

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ dev = [
8888
]
8989

9090
[project.urls]
91+
Documentation = "https://frequenz-floss.github.io/frequenz-model-test/"
9192
Changelog = "https://github.com/frequenz-floss/frequenz-model-test/releases"
9293
Issues = "https://github.com/frequenz-floss/frequenz-model-test/issues"
9394
Repository = "https://github.com/frequenz-floss/frequenz-model-test"

0 commit comments

Comments
 (0)