Skip to content

Commit 4eb2076

Browse files
committed
docs: Add initial SDK DocGen
1 parent d97d3b3 commit 4eb2076

File tree

5 files changed

+28
-1
lines changed

5 files changed

+28
-1
lines changed

.github/workflows/docs.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@ jobs:
1717
run: |
1818
git config user.name github-actions[bot]
1919
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
20+
- name: Checkout a2a-python repo
21+
uses: actions/checkout@v4
22+
with:
23+
repository: google/a2a-python
24+
path: a2a-python-repo
2025
- uses: actions/setup-python@v5
2126
with:
22-
python-version: 3.x
27+
python-version-file: pyproject.toml
2328
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
2429
- uses: actions/cache@v4
2530
with:

a2a-python-repo

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit d1869bb8a74f8a630eae3a7ec434b54d68cae6b4

docs/sdk/python/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Python SDK Reference
2+
3+
This page contains SDK documentation for the [`a2a-python`](https://github.com/a2a-python) package.
4+
5+
::: a2a
6+
options:
7+
show_root_heading: false
8+
show_source: false
9+
show_submodules: true
10+
members_order: alphabetical
11+
inherited_members: true

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ nav:
2727
- Interact with Server: tutorials/python/6-interact-with-server.md
2828
- Streaming & Multiturn: tutorials/python/7-streaming-and-multiturn.md
2929
- Next Steps: tutorials/python/8-next-steps.md
30+
- SDK Reference:
31+
- Python: sdk/python/index.md
3032

3133
# Repository
3234
repo_name: google/A2A
@@ -138,3 +140,10 @@ plugins:
138140
"tutorials/python/8-agent-capabilities.md": "tutorials/python/7-streaming-and-multiturn.md"
139141
"tutorials/python/9-ollama-agent.md": "tutorials/python/7-streaming-and-multiturn.md"
140142
"tutorials/python/10-next-steps.md": "tutorials/python/8-next-steps.md"
143+
- mkdocstrings:
144+
handlers:
145+
python:
146+
options:
147+
show_root_heading: false
148+
show_object_full_path: false
149+
paths: [a2a-python-repo/src]

requirements-docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
mkdocs-material==9.6.12
22
mkdocs-redirects==1.2.2
3+
mkdocstrings[python]

0 commit comments

Comments
 (0)