github / github/copilot-sdk

API docs parity: Python

オープン
#1,655 コメント 5 件 リアクション 1 件 担当者 2 名 @brettcannon が担当を希望しています GitHub で見る
enhancement sdk/python
主要言語
Java
スター
10.5k
フォーク
1.5k
平均マージ
1日 11時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。