Improve docs by avoiding confusion with distutils #3363
Merged
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.
The existing docs seem to assume that the user is familiar with the history of packaging in the Python ecosystem (or at least know what is
distutils
).Since that is not always the case and that
distutils
is in the process of being adopted bysetuptools
, the documentation should be changed to minimize mentions todistutils
and avoid expecting too much knowledge from the users.The benefit of this approach is that it can make the docs more accessible and easier to understand.
This PR is not exhaustive and do not implement all the necessary changes to achieve this view, and it is likely that many follow up PRs would be required.
Summary of changes
setuptools
does (making it more clear to understand for beginners).distutils
,transition to PEP 517
fromuserguide/index
.distutils
from the Quickstart.python2
from the intersphinx mapping - it was causing trouble redirecting glossary terms to Python2 docs, instead of Python3.pip install -e .
)setuptools
commands indistutils
projects was moved to a new file indocs/deprecated/running_commands.rst
Side note: I believe that in the future we can also start adopting some practices as described by the diataxis framework (e.g. strive to create/separate the documentation with different target audiences in mind, as pointed out in this discussion.
Pull Request Checklist
changelog.d/
.(See documentation for details)