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] Clarify that "Keywords" page is an API reference for setuptools.setup #2795

Closed
1 task done
pradyunsg opened this issue Sep 20, 2021 · 1 comment · Fixed by #3307
Closed
1 task done

[Docs] Clarify that "Keywords" page is an API reference for setuptools.setup #2795

pradyunsg opened this issue Sep 20, 2021 · 1 comment · Fixed by #3307

Comments

@pradyunsg
Copy link
Member

Summary

https://setuptools.readthedocs.io/en/latest/references/keywords.html has no indicators what those keywords are for.

It also doesn't show up if you search for "setuptools.setup" in the sidebar search, and is generally innaccessible via search engines as well. It also has poor formatting, likely due to mismanaged indentation on the page.

OS / Environment

No response

Additional Information

It would be good to:

  • have an introductory section in the page, describing what it is for -- explicitly mention "setuptools.setup" in this as well.
  • provide anchors for each of the keyword arguments.
  • fix the indentation for the list of various arguments.

Code of Conduct

  • I agree to follow the PSF Code of Conduct
@pradyunsg pradyunsg added Needs Triage Issues that need to be evaluated for severity and status. documentation labels Sep 20, 2021
@jaraco jaraco added enhancement good first issue help wanted and removed Needs Triage Issues that need to be evaluated for severity and status. labels Sep 20, 2021
@tanvimoharir
Copy link
Contributor

Hi,
I would like to work on this.
Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants