API docs parity: Python

Open
#1,655 5 comments 1 reaction 2 assignees View on GitHub

@brettcannon is already working on this.

Since Jun 16, 2026.

Assessment

This issue has not been assessed yet.

Description

enhancement sdk/python

Python API Docs

Parent epic: #1653

Doc format: Docstrings (reStructuredText or Google/NumPy style) processed by Sphinx or pdoc. Type hints in source also serve as documentation.

Culture: Strong convention to write docstrings. PyPI does not require a docs build to publish, but the community expects it. help() in the REPL reads docstrings directly.

Hosting analogues:

Service How it works
Read the Docs De facto standard host — builds Sphinx/MkDocs on push; free for OSS. Closest cultural equivalent to javadoc.io
pdoc Zero-config generator from docstrings
PyPI project page Renders the long description (usually README), not full API docs

Key difference from Java: No bundled doc artifact in the wheel/sdist. Docs are a separate CI deliverable, typically hosted on Read the Docs.

Dominant language
Java
Stars
10.5k
Forks
1.5k
Avg merge
1d 12h
Merged PRs (30d)
133

Contributor guide

Open the contributing guide

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.

More from github/copilot-sdk

All issues in github/copilot-sdk

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.