Skip to content
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

Merged
merged 5 commits into from
Oct 30, 2024
Merged

#672 Add documentation to the dist. #673

merged 5 commits into from
Oct 30, 2024

Conversation

adiroiban
Copy link
Member

Description

Fixes #672

Update the pyproject.toml

How to test

Run python -m build.
It will generate .tar.gz and .whl files inside the dist/ 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.

@adiroiban adiroiban requested a review from a team as a code owner October 21, 2024 22:20
@adiroiban
Copy link
Member Author

This is ready for review

needs-review

Copy link
Contributor

@twm twm left a 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!

@adiroiban
Copy link
Member Author

Many thanks for the review.

I will exclude github and pre-commit files.

Perhaps also these, as I can't imagine that pre-commit is run by packagers:

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 git clone

I have also removed the pre-commit config.

The developemnt of towncrier should be done using git clone and pre-commit doesn't make much sense without git.

pyproject.toml Outdated Show resolved Hide resolved
@adiroiban adiroiban merged commit 2842821 into trunk Oct 30, 2024
16 checks passed
@adiroiban adiroiban deleted the 672-sdist-doc branch October 30, 2024 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restore documentation to source manifest
2 participants