Exclude docs directory from package distribution #6501
Merged
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #5937 The docs/ directory was being installed to site-packages root instead of being excluded from the package distribution. This could cause conflicts with other packages that have a docs/ directory (similar to the previously fixed examples/ directory issue in #6315). Added 'docs*' and 'docs.*' to the exclude pattern in [tool.setuptools.packages.find] to prevent the documentation files from being included in the wheel distribution.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #5937
Problem
The
docs/directory was being installed tosite-packages/root instead of being excluded from the package distribution. This causes conflicts with other packages that have adocs/directory.For example, installing both
pipenvand another package withdocs/conf.pywould result in one overwriting the other's file, or cause package manager conflicts.This is similar to the previously fixed
examples/directory issue in #6315.Solution
Added
"docs*"and"docs.*"to the exclude pattern in[tool.setuptools.packages.find]section ofpyproject.tomlto prevent the documentation files from being included in the wheel distribution.Changes
pyproject.toml: Addeddocs*anddocs.*to the package exclude listPull Request opened by Augment Code with guidance from the PR author