-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#672 Add documentation to the dist. #673
Conversation
This is ready for review needs-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I do notice that there are some files in the .tar.gz that probably should be omitted:
towncrier-24.8.0.dev0/.github/CODEOWNERS
towncrier-24.8.0.dev0/.github/PULL_REQUEST_TEMPLATE.md
towncrier-24.8.0.dev0/.github/workflows/ci.yml
towncrier-24.8.0.dev0/.git-blame-ignore-revs
Perhaps also these, as I can't imagine that pre-commit is run by packagers:
towncrier-24.8.0.dev0/.pre-commit-config.yaml
towncrier-24.8.0.dev0/.pre-commit-hooks.yaml
None of that blocking, though. Feel free to merge. Thanks!
Many thanks for the review. I will exclude github and pre-commit files.
I think that the idea of source dist, is not necesarily to be used by the packages, but to allow a person to do software development ... without I have also removed the pre-commit config. The developemnt of |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Description
Fixes #672
Update the pyproject.toml
How to test
Run
python -m build
.It will generate
.tar.gz
and.whl
files inside thedist/
folder.Check that the documentation source files are included in the
.tar.gz
version.Check that the documentation files are not included in the
.whl
version..whl
is just a zip file.