rewrite installation section to use pyproject.toml #332
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.
Changes in this PR
fixes #326
The section on creating an installable package has been rewritten to only assume
pyproject.toml
as the relevant file to specify everything in. I've also been a bit more elaborate about what is inpyproject.toml
, since the build system landscape is a bit more stable than it used to be when this was originally written. Speaking of build-system, I've explicitly mentionedhatchling
andsetuptools
as our recommendations, with a link to e.g. the python packaging guide for other options.Checklist
SIGNIFICANT changes / additions, e.g. new chapters
ALL contributions
python3 -m http.server 4000
and confirmed they work correctly.docker run --init -it -v
pwd:/docs lycheeverse/lychee /docs --config=docs/lychee.toml
, at least for the files I changed.CITATION.cff
file.