github / github/copilot-sdk

API docs parity: Python

未关闭
#1,655 5 条评论 1 个 reaction 已指派 2 人 已被 @brettcannon 认领 在 GitHub 查看
enhancement sdk/python
主要语言
Java
星标
10.5k
派生
1.5k
平均合并
1 天 11 小时
30 天内合并 PR
128

描述

## Python API Docs

**Parent epic:** #1653

**Doc format:** Docstrings (reStructuredText or Google/NumPy style) processed by [Sphinx](https://www.sphinx-doc.org/) or [pdoc](https://pdoc.dev/). 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](https://readthedocs.org/) | De facto standard host — builds Sphinx/MkDocs on push; free for OSS. Closest cultural equivalent to javadoc.io |
| [pdoc](https://pdoc.dev/) | 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.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。