fix: include docs and examples in the sdist tarball #2289
Merged
Conversation
This file contains 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
The sdists generated by setuptools included the `docs` and `examples` directories, and they are needed for building docs and running tests using the sdist. This change includes these directories in the sdist tarball. A `test:sdist` task is also added to `Taskfile.yml` which uses the sdists to run pytest and build docs.
aucampia
force-pushed
the
iwana-20230319T1203-sdist_tests
branch
from
bb6cb01
to
359c5d0
Compare
aucampia
added
review wanted
|
Merging without review, as this has no runtime changes and only includes additional content in sdist. |
This was referenced Jul 6, 2023
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 of changes
The sdists generated by setuptools included the
docsandexamplesdirectories, and they are needed for building docs and running tests using the sdist.This change includes these directories in the sdist tarball.
A
test:sdisttask is also added toTaskfile.ymlwhich uses the sdists to run pytest and build docs.Checklist
the same change.
so maintainers can fix minor issues and keep your PR up to date.