Add Read the Docs configuration and Sphinx setup for Python SDK#1663
Draft
Copilot wants to merge 2 commits into
Draft
Add Read the Docs configuration and Sphinx setup for Python SDK#1663Copilot wants to merge 2 commits into
Copilot wants to merge 2 commits into
Conversation
- Add .readthedocs.yaml at repo root for RTD hosting - Create python/docs/ with Sphinx conf.py, index.rst, api.rst, Makefile - Add [project.optional-dependencies] docs group in pyproject.toml - Uses furo theme, autodoc, napoleon, and sphinx-autodoc-typehints Co-authored-by: edburns <75821+edburns@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update API docs for Python to ensure parity
Add Read the Docs configuration and Sphinx setup for Python SDK
Jun 13, 2026
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| author = "GitHub" | ||
|
|
||
| try: | ||
| release = importlib.metadata.version("github-copilot-sdk") |
| try: | ||
| release = importlib.metadata.version("github-copilot-sdk") | ||
| except importlib.metadata.PackageNotFoundError: | ||
| release = "0.0.0.dev0" |
Contributor
Cross-SDK Consistency Review ✅This PR adds documentation infrastructure only — no SDK API surface changes were made. No cross-SDK consistency issues found. Summary of changes reviewed:
Why no action needed: Documentation tooling is inherently ecosystem-specific. Each SDK uses its native documentation system:
No API method signatures, parameter names, return types, or behavioral patterns were changed. This PR does not create any feature parity gaps across SDKs.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the infrastructure to host Python SDK API docs on Read the Docs (free for OSS).
.readthedocs.yaml— RTD v2 config: Ubuntu 24.04, Python 3.12, installspython[docs]python/docs/— Sphinx project with autodoc, napoleon (Google/NumPy docstrings), sphinx-autodoc-typehints, furo themepython/docs/api.rst— API reference covering public surface: CopilotClient, CopilotSession, tools, hooks, events, canvas, MCP, telemetry, session filesystempython/pyproject.toml— Newdocsoptional dependency group (sphinx>=7.0,sphinx-autodoc-typehints>=2.0,furo>=2024.0)Local build:
Activation
After merge, import the project at readthedocs.org — RTD auto-detects
.readthedocs.yamland builds on push.