pypa / pypa/setuptools

[Docs] API reference missing or hidden

Open
#4,119 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I try to find the API reference of setuptools. I expect something like from code autogenerated docu like you can find on ReadTheDocs for other packages.

I only can find this "deprecated" one https://setuptools.pypa.io/en/latest/deprecated/distutils/apiref.html

For example I would like to see the details of "setputools.errors".

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

Start by reviewing the existing setuptools documentation and the deprecated distutils API reference linked in the issue. Then inspect how setuptools.errors is currently documented and determine the scope of the missing API reference. Done means the relevant setuptools API, including setuptools.errors, is available through the project documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.