Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Move command description to the deprecated practice section #3371

Merged
merged 4 commits into from Jun 14, 2022

Conversation

abravalheri
Copy link
Contributor

@abravalheri abravalheri commented Jun 14, 2022

Running commands via python setup.py ... is effectively considered a deprecated practice in setuptools. My interpretation is that, ideally we want people to move on as start using other solutions like pip install . and python -m build.

I believe that we can simplify the main sections of the docs (and make it easier to understand for beginners) if we move these sections that don't make much sense in modern developments to the "backword compatibility and deprecated practice guides".

Summary of changes

  • Move command reference to "guides backword compatibility and deprecated practice"
  • Add a redirection from the previous URL to the new one (this way we don't break any links that people may have to the document).
  • Merge the document with the "Running setuptools commands" document (resulting from a previous extraction/rewrite of the "Development Mode" document.

Closes

Pull Request Checklist

@abravalheri abravalheri marked this pull request as ready for review June 14, 2022 14:30
@abravalheri abravalheri merged commit 94955ce into pypa:main Jun 14, 2022
@abravalheri abravalheri deleted the move-deprecated-docs branch June 14, 2022 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant