Skip to content

Add documentation describing which interfaces are supported. #4979

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jaraco
Copy link
Member

@jaraco jaraco commented May 4, 2025

Closes #4978

@jaraco jaraco force-pushed the debt/supported-interfaces branch from 2816d58 to e7d7e72 Compare May 4, 2025 16:24
Copy link
Contributor

@abravalheri abravalheri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for working on this Jason.

I have started drafting something to integrate with your text:

https://github.com/pypa/setuptools/compare/debt/supported-interfaces...abravalheri:setuptools:supported-interfaces-suggestions?expand=1

Please feel free to have a look and borrow whatever you want from the draft (of if you don't agree just feel free to ignore).

I can see that are a couple more related pages in the docs like https://setuptools.pypa.io/en/latest/userguide/extension.html and https://setuptools.pypa.io/en/latest/deprecated/index.html. So later we may try to coordinate the content among them.

@@ -24,6 +24,7 @@ Contents
.. toctree::
:maxdepth: 1

interfaces
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we include that after quickstart?

I think I understand the need of this to be prominent, but we have 2 classes of users: "someone that wants to do something quick and simple" and "someone that wants to do something complex that requires customisation". Adding the new file before quick start may scare out the first time of users.

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.

Document the supported interfaces of Setuptools
2 participants