Skip to content

Document *all* supported keywords, including those from distutils #1700

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

Closed
pganssle opened this issue Feb 22, 2019 · 0 comments · Fixed by #1765
Closed

Document *all* supported keywords, including those from distutils #1700

pganssle opened this issue Feb 22, 2019 · 0 comments · Fixed by #1765
Labels
documentation help wanted major Needs Implementation Issues that are ready to be implemented.

Comments

@pganssle
Copy link
Member

pganssle commented Feb 22, 2019

When setuptools was first developed and its documentation was first written, it was assumed that you were already using distutils and that you would have read and understood the distutils documentation, which is why setuptools only documents additional keywords, not all the supported options.

However, distutils is deprecated now, and and the distutils documentation is all in legacy mode, plus it's super annoying when you don't know which one contains the keywords you care about.

To satisfy this ticket, we should reorganize the documentation in the following ways:

  1. Move the keywords documentation to their own separate documentation page.
  2. Start moving all the documentation from the distutils. This will be slow going, I imagine, because there does not seem to be a "keyword reference" on distutils. I think you'll have to extract a lot of the values from this prose description, or possibly read the distutils source code itself.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation help wanted major Needs Implementation Issues that are ready to be implemented.
Projects
None yet
1 participant