Step 4: A PEP517-styled quickstart user guide and room for collaboration #2146
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.
This PR should now have incorporated/complemented what's made in #1738 and the
build_meta.txt
file but I will check more thoroughly on that. Please let me know there were mistakes in this documentation too:) I have tried my best to go through the source code to see how keywords insetup.cfg
are handled and tested out my own examples, but there might still be things I overlooked. If there are suggestions please let me know I'm more than happy to have other people's input.Summary of changes
Step 4 on #2093
Proposed a quickstart user guide that adheres to PEP517 and provides a brief overview on the following functionalities of setuptools, with each section pointing to another page (WIP) that covers the details and more advanced usage.
setup.py
tosetup.cfg
Since each section requires a more thorough documentation on the nuances and advance usage, this should make it easier for others to hop in and contribute. For example,
references
)Pull Request Checklist