pypa / pypa/setuptools

[Docs] fully replace python.org/distutils docs

Open
#3,401 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Summary

https://docs.python.org/3/distutils/setupscript.html comes up high in a search, looks like authoritative official guidance on the best way to configure a python project, and it tells people to use setup.py

This page says it will go away when all of the information is available in setuptools documentation:

Note This document is being retained solely until the setuptools documentation at https://setuptools.readthedocs.io/en/latest/setuptools.html independently covers all of the relevant information currently included here.

Additional Information

Not all the documentation should be retained in the setuptools docs.

To break the work up, here are the chapters in distutils docs, and roughly equivalent page in setuptools, if one exists.

Actually deciding the docs are ready for deletion has to be done by that team, this will be tracked at https://github.com/python/cpython/issues/94249

Code of Conduct
  • I agree to follow the PSF Code of Conduct

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the nine linked Distutils chapters and the corresponding Setuptools documentation pages listed in the issue, starting with the chapters that lack an identified equivalent. Check CPython issue 94249 before changing anything, since that team must decide when the Python documentation is ready for deletion. Done means the relevant information is covered or its disposition is agreed and the Distutils documentation can be retired.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.