Skip to content

Commit 558bda3

Browse files
committed
sphinx-ux-autodoc-layout(fix[metadata]): add readme and authors to pyproject
why: twine check on the built wheel and sdist emitted "long_description_content_type missing" and "long_description missing" warnings — the only workspace package doing so. The release.yml pipeline runs `twine check dist/*` after building every publishable package; a CI step that escalates warnings to failures (or a downstream tool that does) would block the next tag push. Every sibling pyproject declares `readme = "README.md"` and `authors = [...]`; this one was the outlier. what: - Add `readme = "README.md"` to [project] (README.md already exists alongside pyproject.toml, so the reference resolves without any file move). - Add `authors = [{name = "Tony Narlock", email = "tony@git-pull.com"}]` to match the sibling pattern. - Verified by rebuilding the package and re-running twine check; output now reads PASSED (previously PASSED with warnings).
1 parent 2eff6b8 commit 558bda3

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/sphinx-ux-autodoc-layout/pyproject.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ build-backend = "hatchling.build"
66
name = "sphinx-ux-autodoc-layout"
77
version = "0.0.1a7"
88
description = "Componentized layout for Sphinx autodoc output"
9+
readme = "README.md"
910
requires-python = ">=3.10"
1011
license = "MIT"
12+
authors = [
13+
{name = "Tony Narlock", email = "tony@git-pull.com"}
14+
]
1115
classifiers = [
1216
"Development Status :: 3 - Alpha",
1317
"License :: OSI Approved :: MIT License",

0 commit comments

Comments
 (0)