Description
After frantically learned, now I am willing to do follow-up of #842. However, I am not sure what should I do.
At this moment, the usage of python -m build
is on the homepage of the documentation. If I copy the "Integration with other tools" to the documentation, it seems that it should follow the usage of python -m build
. However, I think the usage of python -m build
and "Integration with other tools" should be moved to a new chapter named "Usage" or something similar.
And then, I found that the structure of the documentation may be improper. At this moment, chapter "Installation", "Changelog" and "API Documentation" is under the part "Usage". I think it is bad, especially "Changelog" should not be something under "Usage".
I have a plan to do:
- make "Usage" be a chapter parallel to "Installation" and follow it;
- move
python -m build
to chapter "Usage"; - copy "Integration with other tools" and make it follow
python -m build
.
And also, I would like to add a few more specifications in the documentation. For example, I want to link PEP 508 to tell inexperienced end-users what is an "extra", because when I saw pipx run build[uv] --installer=uv
, it was mysterious to me (sorry that I am inexperienced too...) that how [uv]
works and it was a little difficult for me to find the answer.
Thanks.