Do not include documentation files in wheels

mgorny · mgorny · commit 6a8461040bec · 2023-02-04T05:22:50.000+01:00
Fix the `include` entries in `pyproject.toml` to include documentation
files in sdist format only.  Otherwise, they are added to the top-level
wheel directory and they end up being installed directly
in the top-level site-packages directory, e.g.:

    /usr/lib/python3.11/site-packages/CHANGELOG
    /usr/lib/python3.11/site-packages/LICENSE
    /usr/lib/python3.11/site-packages/README.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,9 +23,9 @@ classifiers = [
     'Topic :: Software Development :: Libraries :: Python Modules'
 ]
 include = [
-    "CHANGELOG",
-    "README.md",
-    "LICENSE"
+    { path = "CHANGELOG", format = "sdist" },
+    { path = "README.md", format = "sdist" },
+    { path = "LICENSE", format = "sdist" },
 ]
 
 [tool.poetry.dependencies]

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ classifiers = [`
`23`	`23`	`'Topic :: Software Development :: Libraries :: Python Modules'`
`24`	`24`	`]`
`25`	`25`	`include = [`
`26`		`- "CHANGELOG",`
`27`		`- "README.md",`
`28`		`- "LICENSE"`
	`26`	`+ { path = "CHANGELOG", format = "sdist" },`
	`27`	`+ { path = "README.md", format = "sdist" },`
	`28`	`+ { path = "LICENSE", format = "sdist" },`
`29`	`29`	`]`
`30`	`30`
`31`	`31`	`[tool.poetry.dependencies]`