Skip to content

Add Python API reference docs and generation script for ADK Python 2.0.0#1786

Merged
koverholt merged 3 commits into
mainfrom
python-api-docs-2.0.0
May 20, 2026
Merged

Add Python API reference docs and generation script for ADK Python 2.0.0#1786
koverholt merged 3 commits into
mainfrom
python-api-docs-2.0.0

Conversation

@koverholt
Copy link
Copy Markdown
Collaborator

@koverholt koverholt commented May 20, 2026

Adds generation tooling and built API reference docs for ADK Python 2.0.0.

API reference docs built output (docs/api-reference/python/):

  • 88 documented modules (up from ~55 in the ADK 1.x.x Python build)
  • New: integrations, environment, labs, optimization, skills, workflow, and 18 new tool modules

Tooling (tools/python-api-docs/):

The adk-python repo does not currently include Sphinx config, so this tooling generates API docs independently (similar pattern as the CLI, REST, and Kotlin doc scripts).

  • generate.sh - Clones adk-python at a version tag, installs it, and builds Sphinx HTML
  • discover_modules.py - Discovers public modules from the installed package (generates google-adk.rst at build time)
  • source/conf.py - Sphinx config (Furo theme, autodoc-pydantic, Google Analytics)
  • source/index.rst - Sphinx toctree root

Usage: bash tools/python-api-docs/generate.sh 2.0.0

Staging preview: https://deploy-preview-1786--adk-docs-preview.netlify.app/api-reference/python/

@koverholt koverholt requested a review from joefernandez May 20, 2026 20:10
@netlify
Copy link
Copy Markdown

netlify Bot commented May 20, 2026

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit f523abb
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a0e1fc64e90950009694b14
😎 Deploy Preview https://deploy-preview-1786--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Collaborator

@joefernandez joefernandez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. thanks!

@koverholt koverholt merged commit 6458159 into main May 20, 2026
11 checks passed
@koverholt koverholt deleted the python-api-docs-2.0.0 branch May 20, 2026 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants